govspeak 8.3.1 → 8.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330ac68b36870075d83d6cae5223e28d12186d7b9435be02df50829f11d8c27e
-  data.tar.gz: 3d0b8d3e7b1f98d9e3c814f141319a56a8388ac114b308aba7c3945e5661bbe4
+  metadata.gz: 5a58c52e5a9797911c326259920750977c19b81068825b6b947728fe6af410de
+  data.tar.gz: de9ac98e971c04c0ac4cc6d7e8f1cc987b2a5310ce2efb5bae4aa2b6ec5ccdc0
 SHA512:
-  metadata.gz: c23c1e930d96b6c67fcc9a46c3fc2b1e048d3c5cf9f741e55de28b94bb334e56a07108326cf5bc96c140764f860a0532ff38df87dbb9e04355576f93ebe7efad
-  data.tar.gz: ed762ebf793ee83971ddcf4a5102379b2ad0dea4adea3134c8bd818c9c15d1d03e957b2b433549bc0846525bea1fb3a19c3574eafb1ac46dc1b98f27c59009cb
+  metadata.gz: 21b984b959a200d44869aad30b0d4db910feba0985d701b918152df0fb507cc46710ce0ee9c661f32e93686955f6c2aa722abeb2e95a96527cf3122d53742497
+  data.tar.gz: b33b3accc379b22a62a3354d041b943fdde26a5a3bc040308008d1eb1ebcd2d63b27d18d12a40a774b30b1052ef6b9741f733c6b9f5e3ab495831c305df233f5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 8.3.2
+
+* Various bug fixes related to legislative list components ([#298](https://github.com/alphagov/govspeak/pull/298))
+
 ## 8.3.1
 
 * Bug fixes related to block elements in call to action and legislative list components ([#293](https://github.com/alphagov/govspeak/pull/293))

data/lib/govspeak/version.rb

@@ -1,3 +1,3 @@
 module Govspeak
-  VERSION = "8.3.1".freeze
+  VERSION = "8.3.2".freeze
 end

data/lib/govspeak.rb

@@ -13,7 +13,6 @@ require "govspeak/header_extractor"
 require "govspeak/structured_header_extractor"
 require "govspeak/html_validator"
 require "govspeak/html_sanitizer"
-require "govspeak/kramdown_overrides"
 require "govspeak/blockquote_extra_quote_remover"
 require "govspeak/post_processor"
 require "govspeak/link_extractor"
@@ -298,8 +297,8 @@ module Govspeak
     end
 
     extension("legislative list", /#{NEW_PARAGRAPH_LOOKBEHIND}\$LegislativeList\s*$(.*?)\$EndLegislativeList/m) do |body|
-      # The surrounding div is neccessary to control flow in `parse_block_html` and
-      # maintain the same functionality as a previous version of this extension.
+      # The surrounding div is neccessary to accurately identify legislative lists
+      # in post-processing.
       <<~BODY
         {::options ordered_lists_disabled=\"true\" /}
         <div class="legislative-list-wrapper" markdown="1">#{body}</div>

data/lib/kramdown/parser/govuk.rb

@@ -53,17 +53,111 @@ module Kramdown
       def parse_block_html
         return false if CUSTOM_INLINE_ELEMENTS.include?(@src[1].downcase)
 
+        super
+      end
+
+      # We override the parse_list method with a modified version where ordered lists are
+      # disabled (for use with legislative lists). The majority of the method body is copied
+      # over (from https://github.com/gettalong/kramdown/blob/REL_2_3_1/lib/kramdown/parser/kramdown/list.rb#L54),
+      # only the LIST_START is changed. Previously, we dynamically modified some of the
+      # class-scoped variables used in this method; this provides a thread-safe alternative.
+      def parse_list
         return super unless @options[:ordered_lists_disabled]
 
-        # Kramdown loads parsers into the instance from `options` which are scoped to
-        # the class. Because we are changing these options inside an instance, we must
-        # reconfigure the parser before and after disbaling ordered lists.
-        Govspeak::KramdownOverrides.with_kramdown_ordered_lists_disabled do
-          configure_parser
-          super
+        return if @src.check(LIST_START_OL)
+
+        start_line_number = @src.current_line_number
+        type, list_start_re = (@src.check(LIST_START_UL) ? [:ul, LIST_START_UL] : [:ol, LIST_START_OL])
+        list = new_block_el(type, nil, nil, location: start_line_number)
+
+        item = nil
+        content_re, lazy_re, indent_re = nil
+        eob_found = false
+        nested_list_found = false
+        last_is_blank = false
+        until @src.eos?
+          start_line_number = @src.current_line_number
+          if last_is_blank && @src.check(HR_START)
+            break
+          elsif @src.scan(EOB_MARKER)
+            eob_found = true
+            break
+          elsif @src.scan(list_start_re)
+            list.options[:first_list_marker] ||= @src[1].strip
+            item = Element.new(:li, nil, nil, location: start_line_number)
+            item.value, indentation, content_re, lazy_re, indent_re =
+              parse_first_list_line(@src[1].length, @src[2])
+            list.children << item
+
+            item.value.sub!(self.class::LIST_ITEM_IAL) do
+              parse_attribute_list(::Regexp.last_match(1), item.options[:ial] ||= {})
+              ""
+            end
+
+            list_start_re = fetch_pattern(type, indentation)
+            nested_list_found = (item.value =~ LIST_START_UL)
+            last_is_blank = false
+            item.value = [item.value]
+          elsif (result = @src.scan(content_re)) || (!last_is_blank && (result = @src.scan(lazy_re)))
+            result.sub!(/^(\t+)/) { " " * 4 * ::Regexp.last_match(1).length }
+            indentation_found = result.sub!(indent_re, "")
+            if !nested_list_found && indentation_found && result =~ LIST_START_UL
+              item.value << +""
+              nested_list_found = true
+            elsif nested_list_found && !indentation_found && result =~ LIST_START_UL
+              result = " " * (indentation + 4) << result
+            end
+            item.value.last << result
+            last_is_blank = false
+          elsif (result = @src.scan(BLANK_LINE))
+            nested_list_found = true
+            last_is_blank = true
+            item.value.last << result
+          else
+            break
+          end
         end
 
-        configure_parser
+        @tree.children << list
+
+        last = nil
+        list.children.each do |it|
+          temp = Element.new(:temp, nil, nil, location: it.options[:location])
+
+          env = save_env
+          location = it.options[:location]
+          it.value.each do |val|
+            @src = ::Kramdown::Utils::StringScanner.new(val, location)
+            parse_blocks(temp)
+            location = @src.current_line_number
+          end
+          restore_env(env)
+
+          it.children = temp.children
+          it.value = nil
+
+          it_children = it.children
+          next if it_children.empty?
+
+          # Handle the case where an EOB marker is inserted by a block IAL for the first paragraph
+          it_children.delete_at(1) if it_children.first.type == :p &&
+            it_children.length >= 2 && it_children[1].type == :eob && it_children.first.options[:ial]
+
+          if it_children.first.type == :p &&
+              (it_children.length < 2 || it_children[1].type != :blank ||
+                (it == list.children.last && it_children.length == 2 && !eob_found)) &&
+              (list.children.last != it || list.children.size == 1 ||
+                list.children[0..-2].any? { |cit| !cit.children.first || cit.children.first.type != :p || cit.children.first.options[:transparent] })
+            it_children.first.children.first.value << "\n" if it_children.size > 1 && it_children[1].type != :blank
+            it_children.first.options[:transparent] = true
+          end
+
+          last = (it_children.last.type == :blank ? it_children.pop : nil)
+        end
+
+        @tree.children << last if !last.nil? && !eob_found
+
+        true
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govspeak
 version: !ruby/object:Gem::Version
-  version: 8.3.1
+  version: 8.3.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -235,7 +235,6 @@ files:
 - lib/govspeak/header_extractor.rb
 - lib/govspeak/html_sanitizer.rb
 - lib/govspeak/html_validator.rb
-- lib/govspeak/kramdown_overrides.rb
 - lib/govspeak/link_extractor.rb
 - lib/govspeak/post_processor.rb
 - lib/govspeak/presenters/attachment_image_presenter.rb
@@ -327,7 +326,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: Markup language for single domain

data/lib/govspeak/kramdown_overrides.rb

@@ -1,38 +0,0 @@
-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
-
-    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