govspeak 0.8.9 → 0.8.10

data/README.md

@@ -0,0 +1,164 @@
+Govspeak is our markdown-derived mark-up language.
+
+# Usage
+
+Install the gem
+
+    gem install govspeak
+
+or add it to your Gemfile
+
+    gem "govspeak", "~> 0.8.9"
+
+then create a new document
+
+    require 'rubygems'
+    require 'govspeak'
+
+    doc = Govspeak::Document.new "^Test^"
+    puts doc.to_html
+
+# Extensions
+
+In addition to the [standard Markdown syntax](http://daringfireball.net/projects/markdown/syntax "Markdown syntax"), we have added our own extensions. 
+
+## Callouts
+
+### Information callouts
+
+    ^This is an information callout^
+
+creates a callout with an info (i) icon.
+
+    <div class="application-notice info-notice"> 
+    	<p>This is an information callout</p> 
+    </div>
+
+### Warning callouts
+
+    %This is a warning callout%
+
+creates a callout with a warning or alert (!) icon
+
+    <div class="application-notice help-notice"> 
+    	<p>This is a warning callout</p> 
+    </div>
+
+### Example callout
+
+    $E
+    **Example**: Open the pod bay doors
+    $E
+
+creates an example box
+    
+    <div class="example">
+    <p><strong>Example:</strong> Open the pod bay doors</p>
+    </div>
+
+## Highlights
+
+### Advisory
+
+    @This is a very important message or warning@
+
+highlights the enclosed text in yellow
+
+    <h3 class="advisory">
+    	<span>This is a very important message or warning</span>
+    </h3> 
+
+### Answer
+
+    {::highlight-answer}
+    The VAT rate is *20%*
+    {:/highlight-answer}
+
+creates a large pink highlight box with optional preamble text and giant text denoted with `**`
+
+    <div class="highlight-answer">
+    <p>The standard VAT rate is <em>20%</em></p>
+    </div>
+
+## Points of Contact
+
+### Contact
+
+    $C
+    **Student Finance England**  
+    **Telephone:** 0845 300 50 90  
+    **Minicom:** 0845 604 44 34
+    $C
+
+creates an contact box
+
+    <div class="contact">
+    <p><strong>Student Finance England</strong><br><strong>Telephone:</strong> 0845 300 50 90<br><strong>Minicom:</strong> 0845 604 44 34</p>
+    </div>
+
+### Address
+
+    $A
+    Hercules House
+    Hercules Road
+    London SE1 7DU
+    $A
+
+creates an address box
+
+    <div class="address vcard"><div class="adr org fn"><p>
+    Hercules House
+    <br>Hercules Road  
+    <br>London SE1 7DU   
+    <br></p></div></div>
+
+## Downloads
+
+    $D
+    [An example form download link](http://example.com/ "Example form")
+
+    Something about this form download
+    $D
+
+creates a file download box
+
+    <div class="form-download">
+    <p><a href="http://example.com/" title="Example form" rel="external">An example form download link.</a></p>
+    </div>
+
+## Steps
+
+Steps can be created similar to an ordered list:
+
+    s1. numbers
+    s2. to the start
+    s3. of your list
+
+Note that steps need an extra line break after the final step (ie. two full blank lines) or other markdown directly afterwards won't work. If you have a subhead after - add a line break after this.
+
+## Maps
+
+Static Maps can be embedded by wrapping the URL in double parenthesis.
+
+    ((http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&hl=en&sll=53.800651,-4.064941&sspn=17.759517,42.055664&vpsrc=0&z=14))
+
+## Abbreviations
+
+Abbreviations can be defined at the end of the document, and any occurrences elswhere in the document will wrapped in an `<abbr>` tag. They are parsed in the order in which they are defined, so `PCSOs` should be defined before `PCSO`, for example.
+
+    Special rules apply if you’re exporting a vehicle outside the EU.
+
+    *[EU]:European Union
+
+becomes
+
+    <p>Special rules apply if you’re exporting a vehicle outside the <abbr title="European Union">EU</abbr>.</p>
+
+## Devolved content
+
+    :england:content goes here:england:
+    :scotland:content goes here:scotland:
+    :london:content goes here:london:
+    :wales:content goes here:wales:
+    :northern-ireland:content goes here:northern-ireland:
+    :england-wales:content goes here:england-wales:

data/lib/govspeak.rb

@@ -8,19 +8,26 @@ module Govspeak
 
     @@extensions = []
 
+    attr_accessor :images
+    
     def self.to_html(source, options = {})
       new(source, options).to_html
     end
 
     def initialize(source, options = {})
-      source ||= ""
-      options[:entity_output] ||= :symbolic
-      @doc = Kramdown::Document.new(preprocess(source), options)
+      @source = source ? source.dup : ""
+      @options = options.merge(entity_output: :symbolic)
+      @images = []
       super()
     end
 
+    def kramdown_doc
+      @kramdown_doc ||= Kramdown::Document.new(preprocess(@source), @options)
+    end
+    private :kramdown_doc
+    
     def to_html
-      @doc.to_html
+      kramdown_doc.to_html
     end
 
     def to_text
@@ -28,17 +35,22 @@ module Govspeak
     end
 
     def headers
-      Govspeak::HeaderExtractor.convert(@doc).first
+      Govspeak::HeaderExtractor.convert(kramdown_doc).first
     end
 
     def preprocess(source)
       @@extensions.each do |title,regexp,block|
         source.gsub!(regexp) {|match|
-          block.call($1)
+          instance_exec($1, &block)
         }
       end
       source
     end
+    
+    def encode(text)
+      HTMLEntities.new.encode(text)
+    end
+    private :encode
 
     def self.extension(title, regexp = nil, &block)
       regexp ||= %r${::#{title}}(.*?){:/#{title}}$m
@@ -62,7 +74,7 @@ module Govspeak
       }
     end           
     
-    def self.insert_strong_inside_p(body, parser=Kramdown::Document)
+    def insert_strong_inside_p(body, parser=Kramdown::Document)
       parser.new(body.strip).to_html.sub(/^<p>(.*)<\/p>$/,"<p><strong>\\1</strong></p>")
     end
 
@@ -95,6 +107,25 @@ module Govspeak
     extension('map_link', surrounded_by("((", "))")) { |body|
       %{<div class="map"><iframe width="200" height="200" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="#{body.strip}&output=embed"></iframe><br /><small><a href="#{body.strip}">View Larger Map</a></small></div>}
     }
+    
+    extension('attached-image', /^!!([0-9]+)/) do |image_number|
+      image = images[image_number.to_i - 1]
+      if image
+        caption = image.caption rescue nil
+        render_image(image.url, image.alt_text, caption)
+      else
+        ""
+      end
+    end
+    
+    def render_image(url, alt_text, caption = nil)
+      lines = []
+      lines << '<figure class="image embedded">'
+      lines << %Q{  <div class="img"><img alt="#{encode(alt_text)}" src="#{encode(url)}" /></div>}
+      lines << %Q{  <figcaption>#{encode(caption.strip)}</figcaption>} if caption && !caption.strip.empty?
+      lines << '</figure>'
+      lines.join "\n"
+    end
 
     wrap_with_div('summary', '$!')
     wrap_with_div('form-download', '$D')
@@ -125,13 +156,13 @@ module Govspeak
        'london' => 'London' }
     end
 
-   devolved_options.each do |k,v|
-     extension("devolved-#{k}",/:#{k}:(.*?):#{k}:/m) do |body|
+    devolved_options.each do |k,v|
+      extension("devolved-#{k}",/:#{k}:(.*?):#{k}:/m) do |body|
 %{<div class="devolved-content #{k}">
 <p class="devolved-header">This section applies to #{v}</p>
 <div class="devolved-body">#{Kramdown::Document.new(body.strip).to_html}</div>
 </div>\n}
-     end
-   end
+      end
+    end
   end
 end

data/lib/govspeak/version.rb

@@ -0,0 +1,3 @@
+module Govspeak
+  VERSION = "0.8.10"
+end

data/test/govspeak_test.rb

@@ -7,9 +7,11 @@ SimpleCov.start
 SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
 
 require 'test_helper'
+require 'govspeak_test_helper'
 
 class GovspeakTest < Test::Unit::TestCase
-
+  include GovspeakTestHelper
+  
   test "simple smoke-test" do
     rendered =  Govspeak::Document.new("*this is markdown*").to_html
     assert_equal "<p><em>this is markdown</em></p>\n", rendered
@@ -69,183 +71,270 @@ Teston
     assert_equal %{<div class="address vcard"><div class="adr org fn"><p>\n123 Test Street<br />Testcase Cliffs<br />Teston<br />0123 456 7890 \n</p></div></div>\n}, doc.to_html
   end
 
-  test "govspark extensions" do
-    markdown_regression_tests = [
-{
-  input: "^ I am very informational ^",
-  output: %{<div class="application-notice info-notice">
-<p>I am very informational</p>
-</div>},
-  text: "I am very informational"
-}, {
-  input: "The following is very informational\n^ I am very informational ^",
-  output: %{<p>The following is very informational</p>
-
-<div class="application-notice info-notice">
-<p>I am very informational</p>
-</div>},
-  text: "The following is very informational I am very informational"
-}, {
-  input: "^ I am very informational",
-  output: %{<div class="application-notice info-notice">
-<p>I am very informational</p>
-</div>},
-  text: "I am very informational"
-}, {
-  input: "@ I am very important @",
-  output: %{<div class="advisory"><p><strong>I am very important</strong></p>
-</div>},
-  text: "I am very important"
-}, {
-  input: "The following is very important
-@ I am very important @",
-  output: %{<p>The following is very important</p>
-
-<div class="advisory"><p><strong>I am very important</strong></p>
-</div>},
-  text: "The following is very important I am very important"
-}, {
-  input: "% I am very helpful %",
-  output:  %{<div class="application-notice help-notice">
-<p>I am very helpful</p>
-</div>},
-  text: "I am very helpful"
-}, {
-  input: "The following is very helpful\n% I am very helpful %",
-  output:  %{<p>The following is very helpful</p>
-
-<div class="application-notice help-notice">
-<p>I am very helpful</p>
-</div>},
-  text: "The following is very helpful I am very helpful"
-}, {
-  input: "## Hello ##\n\n% I am very helpful %\r\n### Young Workers ###\n\n",
-  output:  %{<h2 id="hello">Hello</h2>
-
-<div class="application-notice help-notice">
-<p>I am very helpful</p>
-</div>
-
-<h3 id="young-workers">Young Workers</h3>},
-  text: "Hello I am very helpful Young Workers"
-}, {
-  input: "% I am very helpful",
-  output: %{<div class="application-notice help-notice">
-<p>I am very helpful</p>
-</div>},
-  text: "I am very helpful"
-}, {
-  input: "This is a [link](http://www.google.com) isn't it?",
-  output: '<p>This is a <a href="http://www.google.com">link</a> isn&rsquo;t it?</p>',
-  text: "This is a link isn’t it?"
-}, {
-  input: "This is a [link with an at sign in it](http://www.google.com/@dg/@this) isn't it?",
-  output: '<p>This is a <a href="http://www.google.com/@dg/@this">link with an at sign in it</a> isn&rsquo;t it?</p>',
-  text: "This is a link with an at sign in it isn’t it?"
-}, {
-  input: "HTML
-
-  *[HTML]: Hyper Text Markup Language",
-  output: %{<p><abbr title="Hyper Text Markup Language">HTML</abbr></p>},
-  text: "HTML"
-}, {
-  input: "x[a link](http://rubyforge.org)x",
-  output: '<p><a href="http://rubyforge.org" rel="external">a link</a></p>',
-  text: "a link"
-}, {
-  input: "$!
-rainbow
-$!",
-  output: %{<div class="summary">
-<p>rainbow</p>
-</div>},
-  text: "rainbow"
-}, {
-  input: "$C help, send cake $C",
-  output: %{<div class="contact">
-<p>help, send cake</p>
-</div>},
-  text: "help, send cake"
-}, {
-  input: "$A
-street
-road
-$A",
-  output: %{<div class="address vcard"><div class="adr org fn"><p>
-street<br />road<br />
-</p></div></div>},
-  text: "street road"
-}, {
-  input: "$P
-$I
-help
-$I
-$P",
-  output: %{<div class="place">\n<div class="information">\n<p>help</p>\n</div>\n</div>},
-  text: "help"
-}, {
-  input: "$D
-can you tell me how to get to...
-$D",
-  output: %{<div class="form-download">
-<p>can you tell me how to get to…</p>
-</div>},
-  text: "can you tell me how to get to…"
-}, {
-  input: "1. rod
-2. jane
-3. freddy",
-  output: "<ol>\n  <li>rod</li>\n  <li>jane</li>\n  <li>freddy</li>\n</ol>",
-  text: "rod jane freddy"
-}, {
-  input: "
+  test_given_govspeak("^ I am very informational ^") do
+    assert_html_output %{
+      <div class="application-notice info-notice">
+      <p>I am very informational</p>
+      </div>}
+    assert_text_output "I am very informational"
+  end
+
+  test "processing an extension does not modify the provided input" do
+    input = "^ I am very informational"
+    Govspeak::Document.new(input).to_html
+    assert_equal "^ I am very informational", input
+  end
+
+  test_given_govspeak "The following is very informational\n^ I am very informational ^" do
+    assert_html_output %{
+      <p>The following is very informational</p>
+
+      <div class="application-notice info-notice">
+      <p>I am very informational</p>
+      </div>}
+    assert_text_output "The following is very informational I am very informational"
+  end
+  
+  test_given_govspeak "^ I am very informational" do
+    assert_html_output %{
+      <div class="application-notice info-notice">
+      <p>I am very informational</p>
+      </div>}
+    assert_text_output "I am very informational"
+  end
+  
+  test_given_govspeak "@ I am very important @" do
+    assert_html_output %{
+      <div class="advisory"><p><strong>I am very important</strong></p>
+      </div>}
+    assert_text_output "I am very important"
+  end
+  
+  test_given_govspeak "
+    The following is very important
+    @ I am very important @
+    " do
+    assert_html_output %{
+      <p>The following is very important</p>
+
+      <div class="advisory"><p><strong>I am very important</strong></p>
+      </div>}
+    assert_text_output "The following is very important I am very important"
+  end
+  
+  test_given_govspeak "% I am very helpful %" do
+    assert_html_output %{
+      <div class="application-notice help-notice">
+      <p>I am very helpful</p>
+      </div>}
+    assert_text_output "I am very helpful"
+  end
+  
+  test_given_govspeak "The following is very helpful\n% I am very helpful %" do
+    assert_html_output %{
+      <p>The following is very helpful</p>
+
+      <div class="application-notice help-notice">
+      <p>I am very helpful</p>
+      </div>}
+    assert_text_output "The following is very helpful I am very helpful"
+  end
+  
+  test_given_govspeak "## Hello ##\n\n% I am very helpful %\r\n### Young Workers ###\n\n" do
+    assert_html_output %{
+      <h2 id="hello">Hello</h2>
+
+      <div class="application-notice help-notice">
+      <p>I am very helpful</p>
+      </div>
+
+      <h3 id="young-workers">Young Workers</h3>}
+    assert_text_output "Hello I am very helpful Young Workers"
+  end
+  
+  test_given_govspeak "% I am very helpful" do
+    assert_html_output %{
+      <div class="application-notice help-notice">
+      <p>I am very helpful</p>
+      </div>}
+    assert_text_output "I am very helpful"
+  end
+  
+  test_given_govspeak "This is a [link](http://www.google.com) isn't it?" do
+    assert_html_output '<p>This is a <a href="http://www.google.com">link</a> isn&rsquo;t it?</p>'
+    assert_text_output "This is a link isn’t it?"
+  end
+  
+  test_given_govspeak "This is a [link with an at sign in it](http://www.google.com/@dg/@this) isn't it?" do
+    assert_html_output '<p>This is a <a href="http://www.google.com/@dg/@this">link with an at sign in it</a> isn&rsquo;t it?</p>'
+    assert_text_output "This is a link with an at sign in it isn’t it?"
+  end
+  
+  test_given_govspeak "
+    HTML
+
+    *[HTML]: Hyper Text Markup Language" do
+    assert_html_output %{<p><abbr title="Hyper Text Markup Language">HTML</abbr></p>}
+    assert_text_output "HTML"
+  end
+  
+  test_given_govspeak "x[a link](http://rubyforge.org)x" do
+    assert_html_output '<p><a href="http://rubyforge.org" rel="external">a link</a></p>'
+    assert_text_output "a link"
+  end
+  
+  test_given_govspeak "
+    $!
+    rainbow
+    $!" do
+    assert_html_output %{
+      <div class="summary">
+      <p>rainbow</p>
+      </div>}
+    assert_text_output "rainbow"
+  end
+  
+  test_given_govspeak "$C help, send cake $C" do
+    assert_html_output %{
+      <div class="contact">
+      <p>help, send cake</p>
+      </div>}
+    assert_text_output "help, send cake"
+  end
+  
+  test_given_govspeak "
+    $A
+    street
+    road
+    $A" do
+    assert_html_output %{
+      <div class="address vcard"><div class="adr org fn"><p>
+      street<br />road<br />
+      </p></div></div>}
+    assert_text_output "street road"
+  end
+  
+  test_given_govspeak "
+    $P
+    $I
+    help
+    $I
+    $P" do
+    assert_html_output %{<div class="place">\n<div class="information">\n<p>help</p>\n</div>\n</div>}
+    assert_text_output "help"
+  end
+  
+  test_given_govspeak "
+    $D
+    can you tell me how to get to...
+    $D" do
+    assert_html_output %{
+      <div class="form-download">
+      <p>can you tell me how to get to…</p>
+      </div>}
+    assert_text_output "can you tell me how to get to…"
+  end
+  
+  test_given_govspeak "
+    1. rod
+    2. jane
+    3. freddy" do
+    assert_html_output "<ol>\n  <li>rod</li>\n  <li>jane</li>\n  <li>freddy</li>\n</ol>"
+    assert_text_output "rod jane freddy"
+  end
+  
+  test_given_govspeak "
 ((http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&hl=en&sll=53.800651,-4.064941&sspn=17.759517,42.055664&vpsrc=0&z=14))
-",
-  output: %{<div class="map"><iframe width="200" height="200" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&amp;hl=en&amp;sll=53.800651,-4.064941&amp;sspn=17.759517,42.055664&amp;vpsrc=0&amp;z=14&amp;output=embed"></iframe><br /><small><a href="http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&amp;hl=en&amp;sll=53.800651,-4.064941&amp;sspn=17.759517,42.055664&amp;vpsrc=0&amp;z=14">View Larger Map</a></small></div>},
-  text: "View Larger Map"
-}, {
-  input: "s1. zippy
-s2. bungle
-s3. george
-",
-  output: %{<ol class="steps">
-<li><p>zippy</p>\n</li>
-<li><p>bungle</p>\n</li>
-<li><p>george</p>\n</li>
-</ol>},
-  text: "zippy bungle george"
-}
-]
+" do
+    assert_html_output %{<div class="map"><iframe width="200" height="200" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&amp;hl=en&amp;sll=53.800651,-4.064941&amp;sspn=17.759517,42.055664&amp;vpsrc=0&amp;z=14&amp;output=embed"></iframe><br /><small><a href="http://maps.google.co.uk/maps?q=Winkfield+Rd,+Windsor,+Berkshire+SL4+4AY&amp;hl=en&amp;sll=53.800651,-4.064941&amp;sspn=17.759517,42.055664&amp;vpsrc=0&amp;z=14">View Larger Map</a></small></div>}
+    assert_text_output "View Larger Map"
+  end
+  
+  test_given_govspeak "
+    s1. zippy
+    s2. bungle
+    s3. george
+    " do
+    assert_html_output %{
+      <ol class="steps">
+      <li><p>zippy</p>
+      </li>
+      <li><p>bungle</p>
+      </li>
+      <li><p>george</p>
+      </li>
+      </ol>}
+    assert_text_output "zippy bungle george"
+  end
+  
+  test_given_govspeak ":scotland: I am very devolved\n and very scottish \n:scotland:" do
+    assert_html_output '
+      <div class="devolved-content scotland">
+      <p class="devolved-header">This section applies to Scotland</p>
+      <div class="devolved-body"><p>I am very devolved
+       and very scottish</p>
+      </div>
+      </div>
+      '
+  end         
 
-  markdown_regression_tests.each do |t|
-    doc = Govspeak::Document.new(t[:input])
-    assert_equal t[:output].strip, doc.to_html.strip
-    assert_equal t[:text], doc.to_text
+  test_given_govspeak "@ Message with [a link](http://foo.bar/)@" do
+    assert_html_output %{
+      <div class="advisory"><p><strong>Message with <a href="http://foo.bar/">a link</a></strong></p>
+      </div>
+      }  
+  end
+  
+  test "can reference attached images using !!n" do
+    images = [OpenStruct.new(alt_text: 'my alt', url: "http://example.com/image.jpg")]
+    given_govspeak "!!1", images do
+      assert_html_output %Q{
+          <figure class="image embedded">
+            <div class="img"><img alt="my alt" src="http://example.com/image.jpg" /></div>
+          </figure>
+        }
+    end
   end
 
-end
+  test "alt text of referenced images is escaped" do
+    images = [OpenStruct.new(alt_text: %Q{my alt '&"<>}, url: "http://example.com/image.jpg")]
+    given_govspeak "!!1", images do
+      assert_html_output %Q{
+          <figure class="image embedded">
+            <div class="img"><img alt="my alt &apos;&amp;&quot;&lt;&gt;" src="http://example.com/image.jpg" /></div>
+          </figure>
+        }
+    end
+  end
 
-test "devolved markdown sections" do
-    input =  ":scotland: I am very devolved\n and very scottish \n:scotland:"
-    output = '<div class="devolved-content scotland">
-<p class="devolved-header">This section applies to Scotland</p>
-<div class="devolved-body"><p>I am very devolved
- and very scottish</p>
-</div>
-</div>
-'
-
-  assert_equal output, Govspeak::Document.new(input).to_html
-end         
-
-test "links inside markdown boxes" do
-  input = "@ Message with [a link](http://foo.bar/)@"
-  output = %{
-<div class="advisory"><p><strong>Message with <a href="http://foo.bar/">a link</a></strong></p>
-</div>
-}  
-  
-  assert_equal output, Govspeak::Document.new(input).to_html
-end
+  test "silently ignores an image attachment if the referenced image is missing" do
+    doc = Govspeak::Document.new("!!1")
+    doc.images = []
+    
+    assert_equal %Q{\n}, doc.to_html
+  end
+
+  test "adds image caption if given" do
+    images = [OpenStruct.new(alt_text: "my alt", url: "http://example.com/image.jpg", caption: 'My Caption & so on')]
+    given_govspeak "!!1", images do
+      assert_html_output %Q{
+          <figure class="image embedded">
+            <div class="img"><img alt="my alt" src="http://example.com/image.jpg" /></div>
+            <figcaption>My Caption &amp; so on</figcaption>
+          </figure>
+        }
+    end
+  end
+  
+  test "ignores a blank caption" do
+    images = [OpenStruct.new(alt_text: "my alt", url: "http://example.com/image.jpg", caption: '  ')]
+    given_govspeak "!!1", images do
+      assert_html_output %Q{
+          <figure class="image embedded">
+            <div class="img"><img alt="my alt" src="http://example.com/image.jpg" /></div>
+          </figure>
+        }
+    end
+  end
 
 end

data/test/govspeak_test_helper.rb

@@ -0,0 +1,74 @@
+module GovspeakTestHelper
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+    
+  class GovspeakAsserter
+    def initialize(testcase, govspeak, images = [])
+      @testcase = testcase
+      @govspeak = remove_indentation(govspeak)
+      @images = images
+    end
+    
+    def document
+      Govspeak::Document.new(@govspeak).tap do |doc|
+        doc.images = @images
+      end
+    end
+    
+    def assert_text_output(raw_expected)
+      expected = remove_indentation(raw_expected)
+      actual = document.to_text
+      @testcase.assert expected == actual, describe_error(@govspeak, expected, actual)
+    end
+    
+    def assert_html_output(raw_expected)
+      expected = remove_indentation(raw_expected)
+      actual = document.to_html.strip
+      @testcase.assert expected.strip == actual, describe_error(@govspeak, expected.strip, actual)
+    end
+    
+    def remove_indentation(raw)
+      lines = raw.split("\n")
+      if lines.first.empty?
+        lines.delete_at(0)
+        nonblanks = lines.reject { |l| l.match(/^ *$/) }
+        indentation = nonblanks.map do |line|
+          line.match(/^ */)[0].size
+        end.min
+        unindented = lines.map do |line|
+          line[indentation..-1]
+        end
+        unindented.join "\n"
+      else
+        raw
+      end
+    end
+    
+    def describe_error(govspeak, expected, actual)
+      "Expected:\n#{govspeak}\n\nto produce:\n#{show_linenumbers(expected)}\n\nbut got:\n#{show_linenumbers(actual)}\n"
+    end
+    
+    def show_linenumbers(text)
+      lines = text.split "\n"
+      digits = Math.log10(lines.size + 2).ceil
+      lines.map.with_index do |line, i|
+        "%#{digits}d: %s" % [i+1, line]
+      end.join "\n"
+    end
+  end
+
+  def given_govspeak(govspeak, images=[], &block)
+    asserter = GovspeakAsserter.new(self, govspeak, images)
+    asserter.instance_eval(&block)
+  end
+  
+  module ClassMethods
+    def test_given_govspeak(govspeak, &block)
+      test "Given #{govspeak}" do
+        given_govspeak(govspeak, &block)
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: govspeak
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.9
+  version: 0.8.10
 platform: ruby
 authors: 
 - Ben Griffiths
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-30 00:00:00 Z
+date: 2012-02-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: kramdown
@@ -60,10 +60,13 @@ extra_rdoc_files: []
 
 files: 
 - lib/govspeak/header_extractor.rb
+- lib/govspeak/version.rb
 - lib/govspeak.rb
+- README.md
 - Gemfile
 - Rakefile
 - test/govspeak_test.rb
+- test/govspeak_test_helper.rb
 - test/test_helper.rb
 homepage: http://github.com/alphagov/govspeak
 licenses: []
@@ -78,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3606479942582695776
+      hash: -3286011011041893996
       segments: 
       - 0
       version: "0"
@@ -87,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3606479942582695776
+      hash: -3286011011041893996
       segments: 
       - 0
       version: "0"
@@ -100,4 +103,5 @@ specification_version: 3
 summary: Markup language for single domain
 test_files: 
 - test/govspeak_test.rb
+- test/govspeak_test_helper.rb
 - test/test_helper.rb