govspeak 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54b9c75ce59284172221f263176a47cc93035180
-  data.tar.gz: 9a6f7c98b35bc753ecc21e0e8aa25234867d2f19
+  metadata.gz: 62bbf045a81a14edccdebbc6f9bfe8b16053fe83
+  data.tar.gz: 51b63bd95386ba9a1409b8aeab3f9fed85dc169f
 SHA512:
-  metadata.gz: 17fac603e4006e23750e4c129b69650d1ec106a71d0b1568a542fa4f1f65e474edd60c56d39de6297481281c1d1e45a51fbda84c41443915a63e9a9edb59006a
-  data.tar.gz: e29081388c7bf5207a68bd41a7dc1c1fdf0c3d7e3d040d88ee6ce102e9d19e91931f30144d3dc4299f8f0feb3f69c4481f06e3564a3d76767cb7cbf9641f04c5
+  metadata.gz: 144b044eaac74204158ab084b8aa65faa911b0f1f37aee17037950a3a6f89b0da67f2813e448bbeb435429db02fe15db0c087c9ad114d396643ea030ad7e98df
+  data.tar.gz: 2bbad23f71d71361666a73fb59a93eea150134c5e3239c93ed9726e1c6894de96184ae88a2628b9f3201440d98411bc13486d4ddb298eb5a4510da74f1e1e1c6

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.5.2
+
+* Fix a couple of issues with the [header_extractor](https://github.com/alphagov/govspeak/blob/master/lib/govspeak/header_extractor.rb). The method now picks up headers nested inside `blocks`, and when ID's are [explicitly set](http://kramdown.gettalong.org/syntax.html#specifying-a-header-id). See [https://github.com/alphagov/govspeak/pull/66](https://github.com/alphagov/govspeak/pull/66) for more.
+
 ## 3.5.1
 
 * Continue to support non-strict URIs in links on Ruby 2.2.x. See [https://github.com/alphagov/govspeak/issues/57](https://github.com/alphagov/govspeak/issues/57)

data/lib/govspeak/header_extractor.rb

@@ -3,11 +3,45 @@ module Govspeak
 
   class HeaderExtractor < Kramdown::Converter::Base
     def convert(doc)
-      doc.root.children.map do |el|
+      headers = []
+
+      doc.root.children.each do |el|
         if el.type == :header
-          Header.new(el.options[:raw_text], el.options[:level], generate_id(el.options[:raw_text]))
+          headers << build_header(el)
+          next
+        end
+
+        headers << find_headers(el) if el.type == :html_element
+      end
+
+      headers.flatten.compact
+    end
+
+  private
+    def id(el)
+      el.attr.fetch('id', generate_id(el.options[:raw_text]))
+    end
+
+    def build_header(el)
+      Header.new(el.options[:raw_text], el.options[:level], id(el))
+    end
+
+    def find_headers(parent)
+      headers = []
+
+      if parent.type == :header
+        headers << build_header(parent)
+      elsif parent.type == :html_element
+        parent.children.each do |child|
+          if child.type == :header
+            headers << build_header(child)
+          elsif child.children.size > 0
+            headers << find_headers(child)
+          end
         end
-      end.compact
+      end
+
+      headers
     end
   end
-end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "3.5.1"
+  VERSION = "3.5.2"
 end

data/test/govspeak_structured_headers_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class GovspeakStructuredHeadersTest < Test::Unit::TestCase
+class GovspeakStructuredHeadersTest < Minitest::Test
 
   def document_body
     %{

data/test/govspeak_test.rb

@@ -5,7 +5,7 @@ require 'govspeak_test_helper'
 
 require 'ostruct'
 
-class GovspeakTest < Test::Unit::TestCase
+class GovspeakTest < Minitest::Test
   include GovspeakTestHelper
 
   test "simple smoke-test" do
@@ -56,6 +56,43 @@ class GovspeakTest < Test::Unit::TestCase
     ], document.headers
   end
 
+  test "extracts headers when nested inside blocks" do
+    document =  Govspeak::Document.new %{
+# First title
+
+<div markdown="1">
+## Nested subtitle
+</div>
+
+<div>
+<div markdown="1">
+### Double nested subtitle
+</div>
+<div markdown="1">
+### Second double subtitle
+</div>
+</div>
+}
+    assert_equal [
+      Govspeak::Header.new('First title', 1, 'first-title'),
+      Govspeak::Header.new('Nested subtitle', 2, 'nested-subtitle'),
+      Govspeak::Header.new('Double nested subtitle', 3, 'double-nested-subtitle'),
+      Govspeak::Header.new('Second double subtitle', 3, 'second-double-subtitle')
+    ], document.headers
+  end
+
+  test "extracts headers with explicitly specified ids" do
+    document =  Govspeak::Document.new %{
+# First title
+
+## Second title {#special}
+}
+    assert_equal [
+      Govspeak::Header.new('First title', 1, 'first-title'),
+      Govspeak::Header.new('Second title', 2, 'special'),
+    ], document.headers
+  end
+
   test "extracts text with no HTML and normalised spacing" do
     input = "# foo\n\nbar    baz  "
     doc = Govspeak::Document.new(input)

data/test/html_sanitizer_test.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 
-class HtmlSanitizerTest < Test::Unit::TestCase
+class HtmlSanitizerTest < Minitest::Test
 
   test "disallow a script tag" do
     html = "<script>alert('XSS')</script>"

data/test/html_validator_test.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 
-class HtmlValidatorTest < Test::Unit::TestCase
+class HtmlValidatorTest < Minitest::Test
   test "allow Govspeak Markdown" do
     values = [
       "## is H2",

data/test/test_helper.rb

@@ -9,9 +9,9 @@ $:.unshift(File.expand_path("../lib")) unless $:.include?(File.expand_path("../l
 require 'bundler'
 Bundler.setup :default, :development, :test
 
-require 'test/unit'
+require 'minitest/autorun'
 
-class Test::Unit::TestCase
+class Minitest::Test
   class << self
     def test(name, &block)
      clean_name = name.gsub(/\s+/,'_')

data/test/with_deep_merge_test.rb

@@ -1,6 +1,6 @@
 require 'with_deep_merge'
 
-class WithDeepMergeTest < Test::Unit::TestCase
+class WithDeepMergeTest < Minitest::Test
   include WithDeepMerge
 
   def test_simple_merge

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
 platform: ruby
 authors:
 - Ben Griffiths
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -109,6 +109,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement