Merge pull request #349 from alphagov/sengi/fix-bitrot

heathd · web-flow · commit 3af782f60d3e · 2024-05-09T11:00:21.000+01:00
Drop support for end-of-life Ruby versions + update dependencies.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -16,7 +16,9 @@ jobs:
       go: ${{ steps.gem_version.outputs.new_version }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          show-progress: false
 
       - uses: ruby/setup-ruby@v1
         with:
@@ -43,12 +45,14 @@ jobs:
       contents: write  # needed to be able to tag the release
     runs-on: ubuntu-latest
     needs: pre
-    if: ${{ needs.pre.outputs.go == 'true' }}
+    if: needs.pre.outputs.go == 'true'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          show-progress: false
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -1,6 +1,11 @@
 name: Test
 
-on: [push, pull_request]
+on: 
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   test:
@@ -9,12 +14,14 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ['2.7', '3.2']
+        ruby: ['3.1', '3.2', '3.3']
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          show-progress: false
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -3,7 +3,7 @@ inherit_gem:
     - config/default.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
 
 Layout/HeredocIndentation:
   Enabled: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+- BREAKING: drop support for end-of-life Ruby versions 2.7 and 3.0. The minimum Ruby version is now 3.1.
+- Update gem dependencies.
+- Declare some missing indirect dependencies to prepare for Ruby 3.4. This also resolves some warnings about this at build time.
+
 ## 3.5.0
 
 ### New features
diff --git a/govuk_tech_docs.gemspec b/govuk_tech_docs.gemspec
@@ -33,26 +33,30 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
   spec.add_dependency "autoprefixer-rails", "~> 10.2"
+  spec.add_dependency "base64" # TODO: remove once middleman-sprockets declares this itself.
+  spec.add_dependency "bigdecimal" # TODO: remove once activesupport declares this itself.
   spec.add_dependency "chronic", "~> 0.10.2"
-  spec.add_dependency "haml", "< 6.0.0"
+  spec.add_dependency "csv" # TODO: remove once tilt declares this itself.
+  spec.add_dependency "haml", "~> 6.0"
   spec.add_dependency "middleman", "~> 4.0"
-  spec.add_dependency "middleman-autoprefixer", "~> 2.10.0"
-  spec.add_dependency "middleman-compass", ">= 4.0.0"
+  spec.add_dependency "middleman-autoprefixer", "~> 2.10"
+  spec.add_dependency "middleman-compass", "~> 4.0"
   spec.add_dependency "middleman-livereload"
   spec.add_dependency "middleman-search-gds"
   spec.add_dependency "middleman-sprockets", "~> 4.0.0"
-  spec.add_dependency "middleman-syntax", "~> 3.2.0"
+  spec.add_dependency "middleman-syntax", "~> 3.4"
+  spec.add_dependency "mutex_m" # TODO: remove once activesupport declares this itself.
   spec.add_dependency "nokogiri"
   spec.add_dependency "openapi3_parser", "~> 0.9.0"
-  spec.add_dependency "redcarpet", "~> 3.5.1"
+  spec.add_dependency "redcarpet", "~> 3.6"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "capybara", "~> 3.32"
-  spec.add_development_dependency "jasmine", "~> 3.5.0"
+  spec.add_development_dependency "jasmine", "~> 3.5"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.9.0"
-  spec.add_development_dependency "rubocop-govuk", "~> 4.10.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop-govuk", "~> 4.10"
 end
diff --git a/lib/govuk_tech_docs.rb b/lib/govuk_tech_docs.rb
@@ -44,7 +44,7 @@ def self.configure(context, options = {})
                 renderer: TechDocsHTMLRenderer.new(
                   with_toc_data: true,
                   api: true,
-                  context: context,
+                  context:,
                 ),
                 fenced_code_blocks: true,
                 tables: true,
diff --git a/lib/govuk_tech_docs/redirects.rb b/lib/govuk_tech_docs/redirects.rb
@@ -1,6 +1,6 @@
 module GovukTechDocs
   class Redirects
-    LEADING_SLASH = %r{\A/}.freeze
+    LEADING_SLASH = %r{\A/}
 
     def initialize(context)
       @context = context
diff --git a/lib/govuk_tech_docs/table_of_contents/heading_tree_builder.rb b/lib/govuk_tech_docs/table_of_contents/heading_tree_builder.rb
@@ -11,7 +11,7 @@ def tree
         @headings.each do |heading|
           move_to_depth(heading.size)
 
-          @pointer.children << HeadingTree.new(parent: @pointer, heading: heading)
+          @pointer.children << HeadingTree.new(parent: @pointer, heading:)
         end
 
         @tree
diff --git a/lib/govuk_tech_docs/table_of_contents/helpers.rb b/lib/govuk_tech_docs/table_of_contents/helpers.rb
@@ -12,7 +12,7 @@ module Helpers
 
       def single_page_table_of_contents(html, url: "", max_level: nil)
         output = "<ul>\n"
-        output += list_items_from_headings(html, url: url, max_level: max_level)
+        output += list_items_from_headings(html, url:, max_level:)
         output += "</ul>\n"
 
         output
@@ -36,7 +36,7 @@ def list_items_from_headings(html, url: "", max_level: nil)
         end
 
         tree = HeadingTreeBuilder.new(headings).tree
-        HeadingTreeRenderer.new(tree, max_level: max_level).html
+        HeadingTreeRenderer.new(tree, max_level:).html
       end
 
       def render_page_tree(resources, current_page, config, current_page_html)
diff --git a/package-lock.json b/package-lock.json
diff --git a/spec/govuk_tech_docs/source_urls_spec.rb b/spec/govuk_tech_docs/source_urls_spec.rb
@@ -25,16 +25,16 @@
   def generate_config(repo, host)
     {
       tech_docs: {
-        host: host,
+        host:,
         github_repo: repo,
       },
     }
   end
 
   def generate_current_page(title, url)
     OpenStruct.new(
-      data: OpenStruct.new(title: title),
-      url: url,
+      data: OpenStruct.new(title:),
+      url:,
     )
   end
 end
diff --git a/spec/govuk_tech_docs/tech_docs_html_renderer_spec.rb b/spec/govuk_tech_docs/tech_docs_html_renderer_spec.rb
@@ -4,7 +4,7 @@
   let(:app) { double("app") }
   let(:context) { double("context") }
   let(:processor) do
-    Redcarpet::Markdown.new(described_class.new(context: context), tables: true, fenced_code_blocks: true)
+    Redcarpet::Markdown.new(described_class.new(context:), tables: true, fenced_code_blocks: true)
   end
 
   before :each do
@@ -59,7 +59,7 @@ def hello_world
 
     context "without syntax highlighting" do
       let(:processor) do
-        Redcarpet::Markdown.new(described_class.new(context: context), fenced_code_blocks: true)
+        Redcarpet::Markdown.new(described_class.new(context:), fenced_code_blocks: true)
       end
 
       it "sets tab index to 0" do
@@ -78,7 +78,7 @@ def hello_world
         renderer_class = described_class.clone.tap do |c|
           c.send :include, Middleman::Syntax::RedcarpetCodeRenderer
         end
-        Redcarpet::Markdown.new(renderer_class.new(context: context), fenced_code_blocks: true)
+        Redcarpet::Markdown.new(renderer_class.new(context:), fenced_code_blocks: true)
       end
 
       it "sets tab index to 0" do
