govuk_markdown 0.4.0 → 2.0.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587d477359637429b19f4b8657940ad42c53ef5d1e7566432c89ded9e08edad3
-  data.tar.gz: c52c08b4ce188235ba63c2445e372320cfdaafcd2c7be44faf052e1fec80a05d
+  metadata.gz: cf2eeb05a74d3e6dac921b756a58192707d5c4edbb0d706b8d79dbf735dd3279
+  data.tar.gz: 319c0f2a286dd65829c3b08c93f6a6492748445b82c223b60e8120f4285855f7
 SHA512:
-  metadata.gz: c1c54cd75ccfab04de4b900c61802a3a36f9b0e525baa36303c5be7f0a859c1cbbf443467a130b5c322f00be3cd511915f03cd07ba272450a5530802d80c2467
-  data.tar.gz: 1dc06a438f269eabf63de6bb2baa27ff221ffb019c2dcd990e7122dc8b27fbf77202cf80ced11ce2e204aeef5d090e5c742352b54c05b22126b7324404500fe5
+  metadata.gz: 4ba28fd33999e3201ce352baabd21c5a9f3f9959133401cacf39902b8c97259e3dd7ff4aac71db4de31154546f06b61599705e74cab88555f9c357d4cf760345
+  data.tar.gz: 90e4c6e7edea3656159d6532452d4bef11f292a0a9682a661ffcb0ea4e31d88c62efc87b22db3135b54852c02bdb0aff223ddec8119934a5f346a8278aa9ef63

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/CHANGELOG.md

@@ -1,11 +1,18 @@
+## 1.0.0
+
+* Increase minimum supported Ruby version to >= 2.7.0
+* Update dependencies
+* Fix RuboCop violations
+
 ## 0.4.0
 
-This release ensures all links get the `govuk-link` class, no matter which Markdown link syntax is used (#7).
+* Ensure all links get the `govuk-link` class, no matter which Markdown link syntax is used (#7)
 
 ## 0.3.0
 
-This release adds support for tables (#3) and avoids the notorious emphasised `snake_cased_words` issue (#4).
+* Add support for tables (#3)
+* Don’t emphasise snake_cased_words (#4)
 
-## 0.1.0 & 0.2.0
+## 0.1.0 and 0.2.0
 
-Initial release of the code, written by @benilovj and @fofr for the [Get help with tech project](https://github.com/DFE-Digital/get-help-with-tech/pull/171).
+Initial release of the code, written by @benilovj and @fofr for the [Get help with technology service](https://github.com/DFE-Digital/get-help-with-tech/pull/171).

data/Gemfile.lock

@@ -1,84 +1,90 @@
 PATH
   remote: .
   specs:
-    govuk_markdown (0.4.0)
+    govuk_markdown (2.0.0b1)
       activesupport
       redcarpet
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
-    concurrent-ruby (1.1.7)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      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.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.2.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.1)
-    redcarpet (3.5.0)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (0.87.1)
+    rspec-support (3.10.2)
+    rubocop (1.15.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.8.0)
-      parser (>= 2.7.1.5)
-    rubocop-govuk (3.17.2)
-      rubocop (= 0.87.1)
-      rubocop-ast (= 0.8.0)
-      rubocop-rails (= 2.8.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.6.0)
+      parser (>= 3.0.1.1)
+    rubocop-govuk (4.0.0)
+      rubocop (~> 1.15.0)
+      rubocop-ast (~> 1.6.0)
+      rubocop-rails (~> 2.10.0)
       rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 1.42.0)
-    rubocop-rails (2.8.1)
+      rubocop-rspec (~> 2.3.0)
+    rubocop-rails (2.10.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.87.0)
+      rubocop (>= 1.7.0, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.42.0)
-      rubocop (>= 0.87.0)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   govuk_markdown!
+  pry
   rake (~> 13.0)
   rspec
   rubocop-govuk

data/README.md

@@ -36,17 +36,18 @@ Will output:
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
-You can regenerate the example HTML file from Markdown using:
-
-```sh
-bundle exec rake generate_example
-```
+You can regenerate the example HTML file from Markdown using `bundle exec rake generate_example`.
 
 ## Release a new version
 
-Update the version in [lib/govuk_markdown/version.rb](lib/govuk_markdown/version.rb) and merge to main. This will automatically release a new version using GitHub actions.
+1. Update the version in [lib/govuk_markdown/version.rb](lib/govuk_markdown/version.rb)
+2. Run `bundle install`
+3. Update [CHANGELOG.md](CHANGELOG.md)
+4. Create a pull request
+
+When changes are merged into the `main` branch, a new version will be released using a GitHub action.
 
 ## Contributing
 

data/govuk_markdown.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Convert Markdown into GOV.UK styled HTML"
   spec.description   = "Convert Markdown into GOV.UK styled HTML"
   spec.homepage      = "https://github.com/DFE-Digital/govuk_markdown"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -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,64 @@
+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">
+            #{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">
+              #{details}
+            </div>
+          </details>
+        HTML
+      end
+      self
+    end
+
+  private
+
+    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
 
@@ -50,13 +56,14 @@ module GovukMarkdown
     end
 
     def list(contents, list_type)
-      if list_type == :unordered
+      case list_type
+      when :unordered
         <<~HTML
           <ul class="govuk-list govuk-list--bullet">
             #{contents}
           </ul>
         HTML
-      elsif list_type == :ordered
+      when :ordered
         <<~HTML
           <ol class="govuk-list govuk-list--number">
             #{contents}
@@ -72,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 = "0.4.0".freeze
+  VERSION = "2.0.0b1".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: 0.4.0
+  version: 2.0.0b1
 platform: ruby
 authors:
 - Tijmen Brommet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2023-02-07 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
@@ -123,12 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: