govuk_markdown 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587d477359637429b19f4b8657940ad42c53ef5d1e7566432c89ded9e08edad3
-  data.tar.gz: c52c08b4ce188235ba63c2445e372320cfdaafcd2c7be44faf052e1fec80a05d
+  metadata.gz: 69f3f17dd960d5db6cb264a91912850a9e294f3a75c1c936044a58c6b36b7c04
+  data.tar.gz: 7d30fe596d4262f8f445c845a7985e9fa1d18740494ca12e0d644a17371e28f2
 SHA512:
-  metadata.gz: c1c54cd75ccfab04de4b900c61802a3a36f9b0e525baa36303c5be7f0a859c1cbbf443467a130b5c322f00be3cd511915f03cd07ba272450a5530802d80c2467
-  data.tar.gz: 1dc06a438f269eabf63de6bb2baa27ff221ffb019c2dcd990e7122dc8b27fbf77202cf80ced11ce2e204aeef5d090e5c742352b54c05b22126b7324404500fe5
+  metadata.gz: 0a2e32563c6b61b9d51b998a9fa57ed6d5ad5318f080efc4bda6ab27534d7a39f86686407989b5542be205f4e9d60bfd7b169cbceec25b0dd25c627ceb5a6a9b
+  data.tar.gz: abd0235bf969a13863c0dc415c1adefd606c70dda8f857ffd1d39c9126ea9d5334498194bebafa6a7b73b9e627f014cc64f31881989baca2bf973793c73f5207

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,78 +1,78 @@
 PATH
   remote: .
   specs:
-    govuk_markdown (0.4.0)
+    govuk_markdown (1.0.0)
       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)
+    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 (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

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

data/lib/govuk_markdown/renderer.rb

@@ -50,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}

data/lib/govuk_markdown/version.rb

@@ -1,3 +1,3 @@
 module GovukMarkdown
-  VERSION = "0.4.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.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tijmen Brommet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,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