govuk_markdown 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6d0bb270e6c3987985f3da0f956b8a9871c112cc09ca232715a2440773cd8ab
-  data.tar.gz: 6f34ac1e30578e6c6c912e93fc8c6fd410ace73b73903f7c8141559299832c91
+  metadata.gz: 04e0653c66e2b3caa406acdfd07269a638ad834fd0791858f9d71dfa3eb43bbd
+  data.tar.gz: 1b1350d46fc9937987c5077a9130dc0602852afd72f8c57433cb746957290351
 SHA512:
-  metadata.gz: 02aba1d2ccc9623234849df49f3d3fbf90b4b4c180c8e7496d36ca341af39bf16c6cec9a735981906ed94949b21e192fdc200f92f22596f5740db3cb01404d71
-  data.tar.gz: eea2c0cf468653aac44d138fb928292daaaab5fb9d296d1149e6cc28a3ab30a84b2afd7291e47a0ede5a5f5929b5f669a91bc21d5d19adafb7e10cdd6842f75e
+  metadata.gz: 0cb66e8911fc9c18b9a7b05e2737400acc32a6fc444ceccbc0cf1da1e48515f299d793d55be2ec8310fb8b9be759f05fa2abe90b2b7e98ab82fa7d2f1514550c
+  data.tar.gz: 707d0d37111906368efd76b9f9086a7e026ee502ce1e0e31a3651d3b6b952507dad4b262946f4feea980ded9a2dfd22008580f5c61822fee054a9cc2ead7b5ba

data/.github/workflows/publish_gem.yml

@@ -10,14 +10,14 @@ jobs:
     name: Publish to RubyGems.org
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         ref: ${{ github.event.inputs.tag }}
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '2.7.6'
+        ruby-version: '3.1.4'
 
     - name: Install dependencies
       run: |
@@ -26,5 +26,5 @@ jobs:
 
     - name: Publish gem
       uses: dawidd6/action-publish-gem@v1
-      with: 
+      with:
         api_key: ${{ secrets.RUBYGEMS_API_KEY }}

data/.github/workflows/tests.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7.6', '3.0.4', '3.1.2']
+        ruby: ['3.1.4', '3.2.3', '3.3.0']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -23,4 +23,4 @@ jobs:
       run: bundle exec rubocop .
 
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rspec

data/.rubocop.yml

@@ -5,3 +5,6 @@ inherit_gem:
 inherit_mode:
   merge:
     - Exclude
+
+Style/EmptyCaseCondition:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.4

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.0.0
+
+* Add test matrix for Ruby versions 2.7.6, 3.0.4 and 3.1.2 
+* Update Publish Gem workflow to run manually
+* Add support for configurable start heading size
+* Add preprocessor for markdown files
+* Add support for inset text component
+* Add support for details component
+* Add pry as developer dependency
+
 ## 1.0.0
 
 * Increase minimum supported Ruby version to >= 2.7.0

data/Gemfile.lock

@@ -1,83 +1,106 @@
 PATH
   remote: .
   specs:
-    govuk_markdown (2.0.0)
+    govuk_markdown (2.0.2)
       activesupport
       redcarpet
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    i18n (1.8.10)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (3.0.0)
-    rainbow (3.0.0)
-    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.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    racc (1.7.3)
+    rack (3.0.10)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    redcarpet (3.6.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.15.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      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 (~> 2.3.0)
-    rubocop-rails (2.10.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-govuk (4.16.1)
+      rubocop (= 1.62.1)
+      rubocop-ast (= 1.31.2)
+      rubocop-rails (= 2.24.1)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.28.0)
+    rubocop-rails (2.24.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.3.0)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    rubocop-rspec (2.28.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -4,6 +4,8 @@ This Ruby gem converts Markdown into [GOV.UK Frontend](https://github.com/alphag
 
 Don't confuse this gem with [govspeak](https://github.com/alphagov/govspeak), which is a Markdown dialect specifically built for the GOV.UK publishing system (www.gov.uk).
 
+Note that this gem supports [GOV.UK Design System](https://design-system.service.gov.uk/) version 5.3.0.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,6 +16,8 @@ gem 'govuk_markdown'
 
 ## Usage
 
+### Basic usage
+
 ```rb
 GovukMarkdown.render(markdown)
 ```
@@ -32,6 +36,48 @@ Will output:
 </p>
 ```
 
+### Editing the start heading size of headings
+
+By default, H1 headings will be set to XL. You can override the start heading size, for example if you want to start with size L instead.
+
+All subsequent headings i.e. H2, H3, will be sized correctly according to the start heading size. 
+
+Values can be "xl", "l", "m" and "s".
+
+To specify the start heading size for your markdown content, add the below option into your GovukMarkdown.render() method:
+
+```ruby
+GovukMarkdown.render(markdown, headings_start_with: "l")
+```
+
+### Adding inset text to your markdown
+
+To add [inset text](https://design-system.service.gov.uk/components/inset-text/) to your markdown document, use the following tags:
+
+```
+{inset-text}Text to be inset goes here{/inset-text}
+```
+
+The renderer also handles multi-line text as well as multiple paragraphs inside the tags:
+
+```markdown
+{inset-text}
+  Text to be
+  inset goes
+  here
+{/inset-text}
+```
+
+### Adding details sections to your markdown
+
+To add the [details component](https://design-system.service.gov.uk/components/details/) to your markdown, use the following tags:
+
+```
+{details} Find out about the fox and the dog. Whilst the fox is quick and brown, the dog is lazy.{/details}
+```
+
+The first sentence is rendered as the details summary text. The remaining text is rendered as the details text. The renderer handles multiple paragraphs for the details text.
+
 ## Development
 
 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.
@@ -40,15 +86,6 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 You can regenerate the example HTML file from Markdown using `bundle exec rake generate_example`.
 
-## Release a new version
-
-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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/DfE-digital/govuk_markdown.
+Bug reports and pull requests are welcome on GitHub at https://github.com/DfE-digital/govuk-markdown.

data/Rakefile

@@ -1,4 +1,9 @@
+require "mkmf"
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
 task default: :spec
 
 desc "Regenerate the example HTML in example/example.html"
@@ -9,7 +14,15 @@ task :generate_example do
   html = GovukMarkdown.render(markdown)
 
   File.write("example/example.html", ERB.new(File.read("example/example_layout.html.erb")).result(binding))
-  sh "open example/example.html"
+
+  case
+  when find_executable("xdg-open")     # linux
+    sh("xdg-open example/example.html")
+  when find_executable("open")         # mac
+    sh("open example/example.html")
+  else
+    puts "View the example in example/example.html"
+  end
 end
 
 desc "Print the current version of the gem"

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.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.4")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/lib/govuk_markdown/preprocessor.rb

@@ -7,7 +7,7 @@ module GovukMarkdown
     end
 
     def inject_inset_text
-      output.gsub!(build_regexp("inset-text")) do
+      @output = output.gsub(build_regexp("inset-text")) do
         <<~HTML
           <div class="govuk-inset-text">
             #{nested_markdown(Regexp.last_match(1))}
@@ -18,7 +18,7 @@ module GovukMarkdown
     end
 
     def inject_details
-      output.gsub!(build_regexp("details")) do
+      @output = output.gsub(build_regexp("details")) do
         summary, details = *construct_details_from(Regexp.last_match(1))
 
         <<~HTML

data/lib/govuk_markdown/renderer.rb

@@ -26,12 +26,20 @@ module GovukMarkdown
       HTML
     end
 
-    def table_cell(content, _alignment)
-      <<~HTML
-        <td class='govuk-table__cell'>
-          #{content}
-        </td>
-      HTML
+    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)

data/lib/govuk_markdown/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_markdown
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Tijmen Brommet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,14 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Convert Markdown into GOV.UK styled HTML