RubyGems - govuk_markdown - Versions diffs - 2.0.2 → 2.0.4 - Mend

govuk_markdown 2.0.2 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/lib/govuk_markdown/preprocessor.rb +8 -0
data/lib/govuk_markdown/renderer/mixin.rb +97 -0
data/lib/govuk_markdown/renderer.rb +7 -91
data/lib/govuk_markdown/version.rb +1 -1
data/lib/govuk_markdown.rb +2 -1
metadata +6 -5

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e0653c66e2b3caa406acdfd07269a638ad834fd0791858f9d71dfa3eb43bbd
-  data.tar.gz: 1b1350d46fc9937987c5077a9130dc0602852afd72f8c57433cb746957290351
+  metadata.gz: 12e676d3536a62d66092d85e357f8c3e7315c99dfba63908658b7258bc2c2429
+  data.tar.gz: 8d687183bc7ea570bebaed9ac81616fa11e1d3f8c5e32ef3b9b6c6cf2cac68c7
 SHA512:
-  metadata.gz: 0cb66e8911fc9c18b9a7b05e2737400acc32a6fc444ceccbc0cf1da1e48515f299d793d55be2ec8310fb8b9be759f05fa2abe90b2b7e98ab82fa7d2f1514550c
-  data.tar.gz: 707d0d37111906368efd76b9f9086a7e026ee502ce1e0e31a3651d3b6b952507dad4b262946f4feea980ded9a2dfd22008580f5c61822fee054a9cc2ead7b5ba
+  metadata.gz: 748c789cdaa0f0d14eb7ed72b3f7720c1fe6184898afff0f9a6aa07c636be0c24def03328cfdd174f1ff9cf70aa960bda3b45b9ae640117866e95f2235d02f47
+  data.tar.gz: 24ff957175a76b434a18aeac4f221e857ab37e179efc9c6f07635cc959b67ecfa34e3aef16c64202b50d42e7d43da31dc56f9d0d1b5f291d943668a76bb9db90

data/lib/govuk_markdown/preprocessor.rb CHANGED Viewed

@@ -37,6 +37,14 @@ module GovukMarkdown
       self
     end
+    def strip_front_matter(enabled)
+      return self unless enabled
+      @output = output.gsub(%r{^---\n.*\n---}m, "")
+      self
+    end
   private
     # parse as markdown if there are multiple lines of content

data/lib/govuk_markdown/renderer/mixin.rb ADDED Viewed

@@ -0,0 +1,97 @@
+module GovukMarkdown
+  # Renderer::Mixin overrides methods in Redcarpet::Render::HTML.
+  # See `GovukMarkdown::Renderer` for an example of how to include it.
+  module Renderer::Mixin
+    def table(header, body)
+      <<~HTML
+        <table class='govuk-table'>
+          <thead class='govuk-table__head'>
+            #{header}
+          </thead>
+          <tbody class='govuk-table__body'>
+            #{body}
+          </tbody>
+        </table>
+      HTML
+    end
+    def table_row(content)
+      <<~HTML
+        <tr class='govuk-table__row'>
+          #{content}
+        </tr>
+      HTML
+    end
+    def table_cell(content, _alignment, header)
+      if header
+        <<~HTML
+          <th class='govuk-table__header'>
+            #{content}
+          </th>
+        HTML
+      else
+        <<~HTML
+          <td class='govuk-table__cell'>
+            #{content}
+          </td>
+        HTML
+      end
+    end
+    def header(text, header_level)
+      valid_header_sizes = %w[xl l m s].freeze
+      start_size = valid_header_sizes.include?(@headings_start_with) ? @headings_start_with : "xl"
+      start_size_index = valid_header_sizes.find_index(start_size)
+      header_size = valid_header_sizes[start_size_index + header_level - 1] || "s"
+      id_attribute = @options[:with_toc_data] ? " id=\"#{text.parameterize}\"" : ""
+      <<~HTML
+        <h#{header_level}#{id_attribute} class="govuk-heading-#{header_size}">#{text}</h#{header_level}>
+      HTML
+    end
+    def paragraph(text)
+      <<~HTML
+        <p class="govuk-body-m">#{text}</p>
+      HTML
+    end
+    def list(contents, list_type)
+      case list_type
+      when :unordered
+        <<~HTML
+          <ul class="govuk-list govuk-list--bullet">
+            #{contents}
+          </ul>
+        HTML
+      when :ordered
+        <<~HTML
+          <ol class="govuk-list govuk-list--number">
+            #{contents}
+          </ol>
+        HTML
+      else
+        raise "Unexpected type #{list_type.inspect}"
+      end
+    end
+    def hrule
+      <<~HTML
+        <hr class="govuk-section-break govuk-section-break--xl govuk-section-break--visible">
+      HTML
+    end
+    def preprocess(document)
+      Preprocessor
+        .new(document)
+        .inject_inset_text
+        .inject_details
+        .strip_front_matter(@strip_front_matter)
+        .output
+    end
+  end
+end

data/lib/govuk_markdown/renderer.rb CHANGED Viewed

@@ -1,99 +1,15 @@
 module GovukMarkdown
   class Renderer < ::Redcarpet::Render::HTML
-    def initialize(govuk_options, options = {})
-      @headings_start_with = govuk_options[:headings_start_with]
-      super options
-    end
-    def table(header, body)
-      <<~HTML
-        <table class='govuk-table'>
-          <thead class='govuk-table__head'>
-            #{header}
-          </thead>
-          <tbody class='govuk-table__body'>
-            #{body}
-          </tbody>
-        </table>
-      HTML
-    end
-    def table_row(content)
-      <<~HTML
-        <tr class='govuk-table__row'>
-          #{content}
-        </tr>
-      HTML
-    end
-    def table_cell(content, _alignment, header)
-      if header
-        <<~HTML
-          <th class='govuk-table__header'>
-            #{content}
-          </th>
-        HTML
-      else
-        <<~HTML
-          <td class='govuk-table__cell'>
-            #{content}
-          </td>
-        HTML
-      end
-    end
-    def header(text, header_level)
-      valid_header_sizes = %w[xl l m s].freeze
-      start_size = valid_header_sizes.include?(@headings_start_with) ? @headings_start_with : "xl"
+    autoload :Mixin, "govuk_markdown/renderer/mixin"
-      start_size_index = valid_header_sizes.find_index(start_size)
+    include ::Redcarpet::Render::SmartyPants
+    include Mixin
-      header_size = valid_header_sizes[start_size_index + header_level - 1] || "s"
-      id_attribute = @options[:with_toc_data] ? " id=\"#{text.parameterize}\"" : ""
-      <<~HTML
-        <h#{header_level}#{id_attribute} class="govuk-heading-#{header_size}">#{text}</h#{header_level}>
-      HTML
-    end
-    def paragraph(text)
-      <<~HTML
-        <p class="govuk-body-m">#{text}</p>
-      HTML
-    end
-    def list(contents, list_type)
-      case list_type
-      when :unordered
-        <<~HTML
-          <ul class="govuk-list govuk-list--bullet">
-            #{contents}
-          </ul>
-        HTML
-      when :ordered
-        <<~HTML
-          <ol class="govuk-list govuk-list--number">
-            #{contents}
-          </ol>
-        HTML
-      else
-        raise "Unexpected type #{list_type.inspect}"
-      end
-    end
-    def hrule
-      <<~HTML
-        <hr class="govuk-section-break govuk-section-break--xl govuk-section-break--visible">
-      HTML
-    end
+    def initialize(govuk_options, options = {})
+      @headings_start_with = govuk_options[:headings_start_with]
+      @strip_front_matter = govuk_options[:strip_front_matter]
-    def preprocess(document)
-      Preprocessor
-        .new(document)
-        .inject_inset_text
-        .inject_details
-        .output
+      super options
     end
   end
 end

data/lib/govuk_markdown/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module GovukMarkdown
-  VERSION = "2.0.2".freeze
+  VERSION = "2.0.4".freeze
 end

data/lib/govuk_markdown.rb CHANGED Viewed

@@ -4,10 +4,11 @@ require "redcarpet"
 require_relative "./govuk_markdown/version"
 require_relative "./govuk_markdown/preprocessor"
 require_relative "./govuk_markdown/renderer"
+require_relative "./govuk_markdown/renderer/mixin"
 module GovukMarkdown
   def self.render(markdown, govuk_options = {})
-    renderer = GovukMarkdown::Renderer.new(govuk_options, { with_toc_data: true, link_attributes: { class: "govuk-link" } })
+    renderer = GovukMarkdown::Renderer.new(govuk_options, { with_toc_data: true, strip_front_matter: true, link_attributes: { class: "govuk-link" } })
     Redcarpet::Markdown.new(renderer, tables: true, no_intra_emphasis: true).render(markdown).strip
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_markdown
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.4
 platform: ruby
 authors:
 - Tijmen Brommet
-autorequire:
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2026-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,6 +123,7 @@ files:
 - lib/govuk_markdown.rb
 - lib/govuk_markdown/preprocessor.rb
 - lib/govuk_markdown/renderer.rb
+- lib/govuk_markdown/renderer/mixin.rb
 - lib/govuk_markdown/version.rb
 homepage: https://github.com/DFE-Digital/govuk_markdown
 licenses: []
@@ -130,7 +131,7 @@ metadata:
   homepage_uri: https://github.com/DFE-Digital/govuk_markdown
   source_code_uri: https://github.com/DFE-Digital/govuk_markdown
   changelog_uri: https://github.com/DFE-Digital/govuk_markdown
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.26
-signing_key:
+signing_key:
 specification_version: 4
 summary: Convert Markdown into GOV.UK styled HTML
 test_files: []