govspeak 0.8.4 → 0.8.5

data/lib/govspeak.rb

@@ -1,4 +1,5 @@
 require 'kramdown'
+require 'govspeak/header_extractor'
 
 module Govspeak
 
@@ -21,6 +22,10 @@ module Govspeak
       @doc.to_html
     end
 
+    def headers
+      Govspeak::HeaderExtractor.convert(@doc).first
+    end
+
     def preprocess(source)
       @@extensions.each do |title,regexp,block|
         source.gsub!(regexp) {|match|
@@ -66,11 +71,11 @@ module Govspeak
     }
 
     extension('important', surrounded_by("@")) { |body|
-      %{\n\n<h3 class="advisory"><span>#{body.strip}</span></h3>\n}
+      %{\n\n<h3 class="advisory">#{Kramdown::Document.new(body.strip).to_html}</h3>\n}
     }
 
     extension('helpful', surrounded_by("%")) { |body|
-      %{\n\n<div class="application-notice help-notice">\n<p>#{body.strip}</p>\n</div>\n}
+      %{\n\n<div class="application-notice help-notice">\n#{Kramdown::Document.new(body.strip).to_html}</div>\n}
     }
 
     extension('map_link', surrounded_by("((", "))")) { |body|

data/lib/govspeak/header_extractor.rb

@@ -0,0 +1,13 @@
+module Govspeak
+  Header = Struct.new(:text, :level, :id)
+
+  class HeaderExtractor < Kramdown::Converter::Base
+    def convert(doc)
+      doc.root.children.map do |el|
+        if el.type == :header
+          Header.new(el.options[:raw_text], el.options[:level], generate_id(el.options[:raw_text]))
+        end
+      end.compact
+    end
+  end
+end

data/test/govspeak_test.rb

@@ -23,6 +23,29 @@ class GovspeakTest < Test::Unit::TestCase
     assert_equal "<p>this </p>\n\n<p><em>si</em></p>\n\n<p>markdown</p>\n", rendered
   end
 
+  test "extracts headers with text, level and generated id" do
+    document =  Govspeak::Document.new %{
+# Big title
+
+### Small subtitle
+
+## Medium title
+}
+    assert_equal [
+      Govspeak::Header.new('Big title', 1, 'big-title'),
+      Govspeak::Header.new('Small subtitle', 3, 'small-subtitle'),
+      Govspeak::Header.new('Medium title', 2, 'medium-title')
+    ], document.headers
+  end
+
+  test "extracts different ids for duplicate headers" do
+    document =  Govspeak::Document.new("## Duplicate header\n\n## Duplicate header")
+    assert_equal [
+      Govspeak::Header.new('Duplicate header', 2, 'duplicate-header'),
+      Govspeak::Header.new('Duplicate header', 2, 'duplicate-header-1')
+    ], document.headers
+  end
+
   test "govspark extensions" do
     markdown_regression_tests = [
 {
@@ -44,13 +67,15 @@ class GovspeakTest < Test::Unit::TestCase
 </div>}
 }, {
   input: "@ I am very important @",
-  output: %{<h3 class="advisory"><span>I am very important</span></h3>}
+  output: %{<h3 class="advisory"><p>I am very important</p>
+</h3>}
 }, {
   input: "The following is very important
 @ I am very important @",
   output: %{<p>The following is very important</p>
 
-<h3 class="advisory"><span>I am very important</span></h3>}
+<h3 class="advisory"><p>I am very important</p>
+</h3>}
 }, {
   input: "% I am very helpful %",
   output:  %{<div class="application-notice help-notice">
@@ -156,15 +181,25 @@ end
 end
 
 test "devolved markdown sections" do
-    input =  ":scotland: I am very devolved \n and very scottish \n:scotland:"
+    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 
+<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 = %{
+<h3 class="advisory"><p>Message with <a href="http://foo.bar/">a link</a></p>
+</h3>
+}  
+  
   assert_equal output, Govspeak::Document.new(input).to_html
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2011-12-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: &70159122835620 !ruby/object:Gem::Requirement
+  requirement: &70126712036920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.13.3
   type: :runtime
   prerelease: false
-  version_requirements: *70159122835620
+  version_requirements: *70126712036920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70159122835160 !ruby/object:Gem::Requirement
+  requirement: &70126712036220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 0.8.0
   type: :development
   prerelease: false
-  version_requirements: *70159122835160
+  version_requirements: *70126712036220
 description: ! "A set of extensions to markdown layered on top of the kramdown \nlibrary
   for use in the UK Government Single Domain project"
 email:
@@ -43,6 +43,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/govspeak/header_extractor.rb
 - lib/govspeak.rb
 - Gemfile
 - Rakefile
@@ -68,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Markup language for single domain