govuk_markdown 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c2bf69c727cecd9d3e788871391e738b0b712cbd34cbf1ff559c224fddec762
-  data.tar.gz: 5f170bc341b75a0b887dd5eef25a862d553385fa8b79a87e3cba5146099a7e90
+  metadata.gz: 69f3f17dd960d5db6cb264a91912850a9e294f3a75c1c936044a58c6b36b7c04
+  data.tar.gz: 7d30fe596d4262f8f445c845a7985e9fa1d18740494ca12e0d644a17371e28f2
 SHA512:
-  metadata.gz: c809e58e4a5bc3691bd8c892f27e4db3f7de33f262070ffdcacf1328ebd97183b98b61c369d549df0844f68c93aa4029a5334a78cb57ca42edddebfbc11d083a
-  data.tar.gz: 5d1b909df197a7080b0472d4412902c1f08ba1da06530ac2e3a6cd46fe499c1d65658bcb3ed15ee9c3effe5a383b5657090403e9a06d640a4a97c5ad90831cb1
+  metadata.gz: 0a2e32563c6b61b9d51b998a9fa57ed6d5ad5318f080efc4bda6ab27534d7a39f86686407989b5542be205f4e9d60bfd7b169cbceec25b0dd25c627ceb5a6a9b
+  data.tar.gz: abd0235bf969a13863c0dc415c1adefd606c70dda8f857ffd1d39c9126ea9d5334498194bebafa6a7b73b9e627f014cc64f31881989baca2bf973793c73f5207

data/.editorconfig

@@ -0,0 +1,10 @@
+# https://gds-way.cloudapps.digital/manuals/programming-languages/editorconfig
+root = true
+
+[*.{rb,yml}]
+indent_size = 2
+indent_style = space
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.github/workflows/publish_gem.yml

@@ -2,7 +2,7 @@ on:
   - push
 
 jobs:
-  release:
+  build:
     runs-on: ubuntu-latest
     if: ${{ github.ref == 'refs/heads/main' }}
     steps:

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 1.0.0
+
+* Increase minimum supported Ruby version to >= 2.7.0
+* Update dependencies
+* Fix RuboCop violations
+
+## 0.4.0
+
+* Ensure all links get the `govuk-link` class, no matter which Markdown link syntax is used (#7)
+
+## 0.3.0
+
+* Add support for tables (#3)
+* Don’t emphasise snake_cased_words (#4)
+
+## 0.1.0 and 0.2.0
+
+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

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in govuk_markdown.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "bundler"

data/Gemfile.lock

@@ -1,87 +1,85 @@
 PATH
   remote: .
   specs:
-    govuk_markdown (0.1.0)
+    govuk_markdown (1.0.0)
       activesupport
-      bundler
       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)
+    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)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rack (2.2.3)
     rainbow (3.0.0)
-    rake (12.3.3)
-    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
-  bundler
   govuk_markdown!
-  rake (~> 12.0)
+  rake (~> 13.0)
   rspec
   rubocop-govuk
 

data/README.md

@@ -36,13 +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:
+You can regenerate the example HTML file from Markdown using `bundle exec rake generate_example`.
 
-```sh
-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
 

data/Rakefile

@@ -12,6 +12,7 @@ task :generate_example do
   sh "open example/example.html"
 end
 
+desc "Print the current version of the gem"
 task :gem_version do
   require_relative "lib/govuk_markdown/version"
 

data/example/example.html

@@ -40,6 +40,10 @@
   <div class="govuk-width-container">
     <main class="govuk-main-wrapper" id="main-content" role="main">
       <h1 id="a-h1-title-header" class="govuk-heading-xl">A h1 title header</h1>
+<h2 id="links" class="govuk-heading-l">Links</h2>
+<p class="govuk-body-m">This is <a href="https://gov.uk" class="govuk-link">linked text</a>.</p>
+<p class="govuk-body-m">This is <a href="https://gov.uk" title="The best place to find government services and information" class="govuk-link">linked text with a title</a>.</p>
+<p class="govuk-body-m">This is a linked URL <a href="https://www.gov.uk/help" class="govuk-link">https://www.gov.uk/help</a> and this is a linked email address <a href="mailto:noreply@gov.uk" class="govuk-link">noreply@gov.uk</a>.</p>
 <h2 id="lists" class="govuk-heading-l">Lists</h2>
 <p class="govuk-body-m">This is a list:</p>
 <ul class="govuk-list govuk-list--bullet">

data/example/example.md

@@ -1,5 +1,13 @@
 # A h1 title header
 
+## Links
+
+This is [linked text](https://gov.uk).
+
+This is [linked text with a title](https://gov.uk "The best place to find government services and information").
+
+This is a linked URL <https://www.gov.uk/help> and this is a linked email address <noreply@gov.uk>.
+
 ## Lists
 
 This is a list:

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
@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "redcarpet"
-  spec.add_dependency "bundler"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec"

data/lib/govuk_markdown.rb

@@ -6,7 +6,7 @@ require_relative "./govuk_markdown/renderer"
 
 module GovukMarkdown
   def self.render(markdown)
-    renderer = GovukMarkdown::Renderer.new(with_toc_data: true)
-    Redcarpet::Markdown.new(renderer).render(markdown).strip
+    renderer = GovukMarkdown::Renderer.new(with_toc_data: true, link_attributes: { class: "govuk-link" })
+    Redcarpet::Markdown.new(renderer, tables: true, no_intra_emphasis: true).render(markdown).strip
   end
 end

data/lib/govuk_markdown/renderer.rb

@@ -1,5 +1,34 @@
 module GovukMarkdown
   class Renderer < ::Redcarpet::Render::HTML
+    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)
+      <<~HTML
+        <td class='govuk-table__cell'>
+          #{content}
+        </td>
+      HTML
+    end
+
     def header(text, header_level)
       heading_size = case header_level
                      when 1 then "xl"
@@ -21,13 +50,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}
@@ -38,11 +68,6 @@ module GovukMarkdown
       end
     end
 
-    def link(link, title, content)
-      title_attribute = title.present? ? " title=\"#{title}\"" : ""
-      %(<a href="#{link}" class="govuk-link"#{title_attribute}>#{content}</a>)
-    end
-
     def hrule
       <<~HTML
         <hr class="govuk-section-break govuk-section-break--xl govuk-section-break--visible">

data/lib/govuk_markdown/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tijmen Brommet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  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
@@ -101,12 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".github/workflows/publish_gem.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -135,14 +123,14 @@ 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'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.24
 signing_key: 
 specification_version: 4
 summary: Convert Markdown into GOV.UK styled HTML