Merge pull request alphagov#328 from alphagov/ldeb-support-ruby-3.x

Add tests for Ruby 3.x support

Author: lfdebrux

.github/workflows/publish.yaml

@@ -46,10 +46,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
+          node-version-file: '.nvmrc'
           cache: 'npm'
-          node-version: '14'
 
       - uses: ruby/setup-ruby@v1
         with:

.github/workflows/test.yaml

@@ -7,16 +7,21 @@ jobs:
     name: Test
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.2']
+
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: '14'
+          node-version-file: '.nvmrc'
           cache: 'npm'
 
       - uses: ruby/setup-ruby@v1
         with:
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
       - name: Run tests

.nvmrc

@@ -1 +1 @@
-14
+18

.rubocop.yml

@@ -2,6 +2,9 @@ inherit_gem:
   rubocop-govuk:
     - config/default.yml
 
+AllCops:
+  TargetRubyVersion: 2.7
+
 Layout/HeredocIndentation:
   Enabled: false
 

.ruby-version

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- You no longer need to downgrade Haml yourself, `bundle install` will now make sure Haml 6 is not installed (see issue [#318: Error: Filters is not a module](https://github.com/alphagov/tech-docs/gem/issues/318)).
+
 ## 3.3.1
 
 This change solves a potential security issue with HTML snippets. Pages indexed in search results have their entire contents indexed, including any HTML code snippets. These HTML snippets would appear in the search results unsanitised, making it possible to render arbitrary HTML or run arbitrary scripts.

CHANGELOG.md

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in govuk_tech_docs.gemspec
 gemspec

Gemfile

@@ -1,13 +1,14 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+require "English"
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "govuk_tech_docs/version"
 
 `npm install`
-abort 'npm install failed' unless $?.success?
+abort "npm install failed" unless $CHILD_STATUS.success?
 
-unless File.exist?('node_modules/govuk-frontend/govuk/all.scss')
-  abort 'govuk-frontend npm package not installed'
+unless File.exist?("node_modules/govuk-frontend/govuk/all.scss")
+  abort "govuk-frontend npm package not installed"
 end
 
 Gem::Specification.new do |spec|
@@ -16,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Government Digital Service"]
   spec.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
 
-  spec.summary       = %q{Gem to distribute the GOV.UK Tech Docs Template}
-  spec.description   = %q{Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem for the project.}
+  spec.summary       = "Gem to distribute the GOV.UK Tech Docs Template"
+  spec.description   = "Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem for the project."
   spec.homepage      = "https://github.com/alphagov/tech-docs-gem"
   spec.license       = "MIT"
 
@@ -30,7 +31,9 @@ Gem::Specification.new do |spec|
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = %w[lib]
+
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.add_dependency "autoprefixer-rails", "~> 10.2"
   spec.add_dependency "chronic", "~> 0.10.2"
@@ -44,11 +47,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "nokogiri"
   spec.add_dependency "openapi3_parser", "~> 0.9.0"
   spec.add_dependency "redcarpet", "~> 3.5.1"
+  spec.add_dependency "haml", "< 6.0.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "capybara", "~> 3.32"
   spec.add_development_dependency "jasmine", "~> 3.5.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9.0"
-  spec.add_development_dependency "rubocop-govuk", "~> 3.5.0"
+  spec.add_development_dependency "rubocop-govuk", "~> 4.10.0"
 end

govuk_tech_docs.gemspec

@@ -86,8 +86,8 @@ def format_date(date)
       def active_page(page_path)
         [
           page_path == "/" && current_page.path == "index.html",
-          ("/" + current_page.path) == page_path,
-          current_page.data.parent != nil && current_page.data.parent.to_s == page_path,
+          "/#{current_page.path}" == page_path,
+          !current_page.data.parent.nil? && current_page.data.parent.to_s == page_path,
         ].any?
       end
     end
@@ -109,9 +109,9 @@ def active_page(page_path)
         search.resources = [""]
 
         search.fields = {
-          title:   { boost: 100, store: true, required: true },
+          title: { boost: 100, store: true, required: true },
           content: { boost: 50, store: true },
-          url:     { index: false, store: true },
+          url: { index: false, store: true },
         }
 
         search.pipeline_remove = %w[stemmer stopWordFilter]

lib/govuk_tech_docs.rb

@@ -37,7 +37,7 @@ def initialize(app, options_hash = {}, &block)
 
       def uri?(string)
         uri = URI.parse(string)
-        %w(http https).include?(uri.scheme)
+        %w[http https].include?(uri.scheme)
       rescue URI::BadURIError
         false
       rescue URI::InvalidURIError