govuk_markdown 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69f3f17dd960d5db6cb264a91912850a9e294f3a75c1c936044a58c6b36b7c04
-  data.tar.gz: 7d30fe596d4262f8f445c845a7985e9fa1d18740494ca12e0d644a17371e28f2
+  metadata.gz: c6d0bb270e6c3987985f3da0f956b8a9871c112cc09ca232715a2440773cd8ab
+  data.tar.gz: 6f34ac1e30578e6c6c912e93fc8c6fd410ace73b73903f7c8141559299832c91
 SHA512:
-  metadata.gz: 0a2e32563c6b61b9d51b998a9fa57ed6d5ad5318f080efc4bda6ab27534d7a39f86686407989b5542be205f4e9d60bfd7b169cbceec25b0dd25c627ceb5a6a9b
-  data.tar.gz: abd0235bf969a13863c0dc415c1adefd606c70dda8f857ffd1d39c9126ea9d5334498194bebafa6a7b73b9e627f014cc64f31881989baca2bf973793c73f5207
+  metadata.gz: 02aba1d2ccc9623234849df49f3d3fbf90b4b4c180c8e7496d36ca341af39bf16c6cec9a735981906ed94949b21e192fdc200f92f22596f5740db3cb01404d71
+  data.tar.gz: eea2c0cf468653aac44d138fb928292daaaab5fb9d296d1149e6cc28a3ab30a84b2afd7291e47a0ede5a5f5929b5f669a91bc21d5d19adafb7e10cdd6842f75e

data/.github/workflows/publish_gem.yml

@@ -1,28 +1,30 @@
+name: Publish gem
 on:
-  - push
-
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: Tag
+        required: true
 jobs:
   build:
+    name: Publish to RubyGems.org
     runs-on: ubuntu-latest
-    if: ${{ github.ref == 'refs/heads/main' }}
     steps:
     - uses: actions/checkout@v2
-    - uses: ruby/setup-ruby@v1
-    - name: Install dependencies
-      run: gem update --system
+      with:
+        ref: ${{ github.event.inputs.tag }}
 
-    - env:
-        GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-      name: Push a new gem version to Rubygems
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7.6'
+
+    - name: Install dependencies
       run: |
-        CURRENT_VERSION=$(rake gem_version)
-        PUBLISHED_GEM_VERSION=$(gem list --exact --remote govuk_markdown)
+        gem install bundler
+        bundle install --jobs 4 --retry 3
 
-        if [ "${PUBLISHED_GEM_VERSION}" != "govuk_markdown (${CURRENT_VERSION})" ]; then
-          gem build govuk_markdown.gemspec
-          gem push "govuk_markdown-${CURRENT_VERSION}.gem"
-        fi
-        if ! git ls-remote --tags --exit-code origin v${CURRENT_VERSION}; then
-          git tag v${CURRENT_VERSION}
-          git push --tags
-        fi
+    - name: Publish gem
+      uses: dawidd6/action-publish-gem@v1
+      with: 
+        api_key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.github/workflows/tests.yml

@@ -1,22 +1,26 @@
 name: Ruby
-
 on:
   - pull_request
-
 jobs:
-  test:
-
+  rspec:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7.6', '3.0.4', '3.1.2']
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
+
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: ${{ matrix.ruby }}
+
     - name: Install dependencies
       run: bundle install --jobs 4 --retry 3
+
     - name: Run linter
       run: bundle exec rubocop .
+
     - name: Run tests
       run: bundle exec rake

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    govuk_markdown (1.0.0)
+    govuk_markdown (2.0.0)
       activesupport
       redcarpet
 
@@ -15,15 +15,20 @@ GEM
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
     minitest (5.14.4)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (3.0.0)
     rainbow (3.0.0)
     rake (13.0.6)
     redcarpet (3.5.1)
@@ -79,6 +84,7 @@ PLATFORMS
 
 DEPENDENCIES
   govuk_markdown!
+  pry
   rake (~> 13.0)
   rspec
   rubocop-govuk

data/govuk_markdown.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "redcarpet"
 
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop-govuk"

data/lib/govuk_markdown/preprocessor.rb

@@ -0,0 +1,71 @@
+module GovukMarkdown
+  class Preprocessor
+    attr_reader :output
+
+    def initialize(document)
+      @output = document
+    end
+
+    def inject_inset_text
+      output.gsub!(build_regexp("inset-text")) do
+        <<~HTML
+          <div class="govuk-inset-text">
+            #{nested_markdown(Regexp.last_match(1))}
+          </div>
+        HTML
+      end
+      self
+    end
+
+    def inject_details
+      output.gsub!(build_regexp("details")) do
+        summary, details = *construct_details_from(Regexp.last_match(1))
+
+        <<~HTML
+          <details class="govuk-details" data-module="govuk-details">
+            <summary class="govuk-details__summary">
+              <span class="govuk-details__summary-text">
+              #{summary}
+              </span>
+            </summary>
+            <div class="govuk-details__text">
+              #{nested_markdown(details)}
+            </div>
+          </details>
+        HTML
+      end
+      self
+    end
+
+  private
+
+    # parse as markdown if there are multiple lines of content
+    def nested_markdown(content)
+      return content unless content =~ /\n/
+
+      GovukMarkdown.render(content)
+    end
+
+    def build_regexp(tag_name, pre_tag: "{", post_tag: "}", closing: "/")
+      start_tag = pre_tag + tag_name + post_tag
+      end_tag = pre_tag + closing + tag_name + post_tag
+      pattern = [Regexp.quote(start_tag), "(.*?)", Regexp.quote(end_tag)].join
+
+      Regexp.compile(pattern, Regexp::EXTENDED | Regexp::MULTILINE)
+    end
+
+    def construct_details_from(match_string, partition_characters: %w[? .])
+      summary_text, match, details = match_string.partition(Regexp.union(*partition_characters))
+
+      summary = [summary_text, format_punctuation(match)].compact.join
+
+      [summary, details].compact.map(&:strip)
+    end
+
+    def format_punctuation(match)
+      return if match.include?(".")
+
+      match
+    end
+  end
+end

data/lib/govuk_markdown/renderer.rb

@@ -1,5 +1,10 @@
 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'>
@@ -30,16 +35,17 @@ module GovukMarkdown
     end
 
     def header(text, header_level)
-      heading_size = case header_level
-                     when 1 then "xl"
-                     when 2 then "l"
-                     when 3 then "m"
-                     else "s" end
+      valid_header_sizes = %w[xl l m s].freeze
 
-      id_attribute = @options[:with_toc_data] ? " id=\"#{text.parameterize}\"" : ""
+      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-#{heading_size}">#{text}</h#{header_level}>
+        <h#{header_level}#{id_attribute} class="govuk-heading-#{header_size}">#{text}</h#{header_level}>
       HTML
     end
 
@@ -73,5 +79,13 @@ module GovukMarkdown
         <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
+        .output
+    end
   end
 end

data/lib/govuk_markdown/version.rb

@@ -1,3 +1,3 @@
 module GovukMarkdown
-  VERSION = "1.0.0".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/govuk_markdown.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_markdown
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tijmen Brommet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +121,7 @@ files:
 - example/govuk-frontend-3.9.1.min.css
 - govuk_markdown.gemspec
 - lib/govuk_markdown.rb
+- lib/govuk_markdown/preprocessor.rb
 - lib/govuk_markdown/renderer.rb
 - lib/govuk_markdown/version.rb
 homepage: https://github.com/DFE-Digital/govuk_markdown
@@ -130,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Convert Markdown into GOV.UK styled HTML