govspeak 1.5.4 → 1.6.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.6.0
+
+* Add `$LegislativeList` to allow editors to insert lists with custom markers.
+
 ## 1.5.4
 
 * Stop steps list regex matching newline.

data/lib/govspeak.rb

@@ -3,6 +3,7 @@ require 'govspeak/header_extractor'
 require 'govspeak/structured_header_extractor'
 require 'govspeak/html_validator'
 require 'govspeak/html_sanitizer'
+require 'govspeak/kramdown_overrides'
 require 'kramdown/parser/kramdown_with_automatic_external_links'
 require 'htmlentities'
 
@@ -159,6 +160,16 @@ module Govspeak
       %{<div class="address"><div class="adr org fn"><p>\n#{body.sub("\n", "").gsub("\n", "<br />")}\n</p></div></div>\n}
     }
 
+    extension("legislative list", /\$LegislativeList\s*$(.*?)(?:^\s*$|\Z)/m) do |body|
+      Govspeak::KramdownOverrides.with_kramdown_ordered_lists_disabled do
+        Kramdown::Document.new(body.strip).to_html.tap do |doc|
+          doc.gsub!('<ul>', '<ol>')
+          doc.gsub!('</ul>', '</ol>')
+          doc.sub!('<ol>', '<ol class="legislative-list">')
+        end
+      end
+    end
+
     extension("numbered list", /^[ \t]*((s\d+\.\s.*(?:\n|$))+)/) do |body|
       steps ||= 0
       body.gsub!(/s(\d+)\.\s(.*)(?:\n|$)/) do |b|

data/lib/govspeak/kramdown_overrides.rb

@@ -0,0 +1,39 @@
+module Govspeak
+  module KramdownOverrides
+    # This depends on two internal parts of Kramdown.
+    # 1. Parser registry (kramdown/parser/kramdown.rb#define_parser)
+    # 2. Kramdown list regexes (kramdown/parser/kramdown/list.rb)
+    # Updating the Kramdown gem therefore also means updating this file to to
+    # match Kramdown's internals.
+
+    def self.with_kramdown_ordered_lists_disabled
+      original_list_start = list_start 
+      redefine_kramdown_const(:LIST_START, list_start_ul)
+      list_parser = kramdown_parsers.delete(:list)
+      Kramdown::Parser::Kramdown.define_parser(:list, list_start_ul)
+
+      yield
+    ensure
+      redefine_kramdown_const(:LIST_START, original_list_start)
+      kramdown_parsers[:list] = list_parser
+    end
+
+  private
+    def self.list_start
+      Kramdown::Parser::Kramdown::LIST_START
+    end
+
+    def self.list_start_ul
+      Kramdown::Parser::Kramdown::LIST_START_UL
+    end
+
+    def self.kramdown_parsers
+      Kramdown::Parser::Kramdown.class_variable_get("@@parsers")
+    end
+
+    def self.redefine_kramdown_const(const, value)
+      Kramdown::Parser::Kramdown.send(:remove_const, const)
+      Kramdown::Parser::Kramdown.send(:const_set, const, value)
+    end
+  end
+end

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "1.5.4"
+  VERSION = "1.6.0"
 end

data/test/govspeak_test.rb

@@ -396,6 +396,28 @@ $CTA
     assert_text_output "unordered list step list"
   end
 
+  test_given_govspeak "
+    $LegislativeList
+    * 1. The quick
+    * 2. Brown fox
+      * a) Jumps over
+      * b) The lazy
+    * 3. Dog
+  " do
+    assert_html_output %{
+      <ol class="legislative-list">
+        <li>1. The quick</li>
+        <li>2. Brown fox
+          <ol>
+            <li>a) Jumps over</li>
+            <li>b) The lazy</li>
+          </ol>
+        </li>
+        <li>3. Dog</li>
+      </ol>
+    }
+  end
+
   test_given_govspeak "
     Zippy, Bungle and George did not qualify for the tax exemption in s428. They filled in their tax return accordingly.
     " do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -153,6 +153,7 @@ files:
 - lib/kramdown/parser/kramdown_with_automatic_external_links.rb
 - lib/govspeak.rb
 - lib/govspeak/html_validator.rb
+- lib/govspeak/kramdown_overrides.rb
 - lib/govspeak/version.rb
 - lib/govspeak/html_sanitizer.rb
 - lib/govspeak/header_extractor.rb
@@ -181,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17277922338174539
+      hash: 3370036994273431811
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 17277922338174539
+      hash: 3370036994273431811
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23