optic14n 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6082fa0cb69d729e1329bb5fd04ffd5f40e9632bfa91008bd323e6c2f3c9222
-  data.tar.gz: 46da722d37cc308d168b935df6c0458437a5cbb993e30a8e603cdd58dbfbc75a
+  metadata.gz: 7479db1ec2e377b50be0f54167958b1d7f6a49d45d662b26c19c840a61dfbb3f
+  data.tar.gz: ec11d6132aeec024bc68bcf85876645ddd2a4aff726b52468f2e367a119587b5
 SHA512:
-  metadata.gz: 8578848462e54c7f940cbb6fe939059150f36ae28026faa1f7a7b2803ec21d44d2f8af8c624be5ccea539b6cb4b7c3646e5092f24ec9e5a7eb4952a9fcd79d4d
-  data.tar.gz: 94ba871eaf0864f8d4dde07428ccae007aee0e895b1ac9fa7a5876b05388b678697ce38159aac44177b4863c4a3279c8089e6cf652fcc32f89c578ec8ccf44f3
+  metadata.gz: a334df2fd339fbb0ce41554ae781f0fe24ff303116551e69a341ce4279f6239461d57565dcf285c7731328ddf597ae0536214e334251074f08ad02729543db49
+  data.tar.gz: 57c8eb1545b3d422c1ac53599928d41b0536ea445d3c7fc1567caebe58c7bc315266454124c946aa119e498c604a7342fa7ea7b97ecb4e8daeb0ba0660073889

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: daily

data/.github/pull_request_template.md

@@ -0,0 +1 @@
+This repo is owned by the publishing platform team. Please let us know in #govuk-publishing-platform when you raise any PRs.

data/.github/workflows/autorelease.yml

@@ -0,0 +1,10 @@
+on:
+  workflow_dispatch: {}
+  schedule:
+    - cron: '30 10 * * 1-5' # 10:30am UTC, Mon-Fri.
+
+jobs:
+  autorelease:
+    uses: alphagov/govuk-infrastructure/.github/workflows/autorelease-rubygem.yml@main
+    secrets:
+      GH_TOKEN: ${{ secrets.GOVUK_CI_GITHUB_API_TOKEN }}

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+on: [push, pull_request]
+
+jobs:
+  codeql-sast:
+    name: CodeQL SAST scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main
+    permissions:
+      security-events: write
+
+  dependency-review:
+    name: Dependency Review scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
+  
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.1, 3.2, 3.3]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.govuk_dependabot_merger.yml

@@ -0,0 +1,7 @@
+api_version: 2
+defaults:
+  allowed_semver_bumps:
+    - patch
+    - minor
+  auto_merge: true
+  update_external_dependencies: true

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.1.4

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+- We use the [GOV.UK versioning guidelines](https://docs.publishing.service.gov.uk/manual/publishing-a-ruby-gem.html#versioning).
+- Mark breaking changes with `BREAKING:`. Be sure to include instructions on how applications should be upgraded.
+- Don't include changes that are purely internal. The CHANGELOG should be a
+  useful summary for people upgrading their application, not a replication
+  of the commit log.
+
+## Unreleased
+
+## 3.0.0
+
+[Full diff](https://github.com/alphagov/optic14n/compare/v2.1.0...v3.0.0)
+
+- BREAKING: Bump minimum Ruby version from 2.6.5 to 3.1.4
+- Add support for Ruby 3.3
+- BREAKING: Bump minimum rubocop-govuk version from 1.0.0 to 5.0.2

data/README.md

@@ -58,3 +58,7 @@ smaller than it would otherwise be. We do this aggressively by:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Licence
+
+[MIT License](LICENCE)

data/Rakefile

@@ -1,15 +1,12 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
-begin
-  require "rspec/core/rake_task"
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-  puts "Running in production mode"
-end
-
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 require "bundler/gem_tasks"
 require "optic14n"
 Dir.glob("lib/tasks/*.rake").each { |r| import r }
 
-task default: :spec
-task test: :spec
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/lib/optic14n/version.rb

@@ -1,3 +1,3 @@
 module Optic14n
-  VERSION = "2.1.0".freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/uri/bluri.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module URI
   ##
   # A URI class with a bit extra for canonicalising query strings
@@ -21,13 +19,13 @@ module URI
       "%21" => "!",
     }.freeze
 
-    REQUIRE_REGEX_ESCAPE = %w<. | ( ) [ ] { } + \ ^ $ * ?> & PATH_ESCAPE_MAPPINGS.keys
+    REQUIRE_REGEX_ESCAPE = [".", "|", "(", ")", "[", "]", "{", "}", "+", " ^", "$", "*", "?"] & PATH_ESCAPE_MAPPINGS.keys
 
     extend Forwardable
 
     def_delegators :@uri, :scheme, :path, :host, :host=, :query, :fragment, :to_s
 
-    def initialize(uri_str)
+    def initialize(uri_str) # rubocop:disable Lint/MissingSuper - This class seems a reimplementation rather than an ancestor
       @uri = ::Addressable::URI.parse(uri_str)
 
       raise URI::InvalidURIError, "'#{uri_str}' not a valid URI" unless valid_uri?
@@ -40,7 +38,7 @@ module URI
     end
 
     def query_hash
-      @query_hash ||= CGI::parse(self.query || "").tap do |query_hash|
+      @query_hash ||= CGI.parse(query || "").tap do |query_hash|
         # By default, CGI::parse produces lots of arrays. Usually they have a single element
         # in them. That's correct but not terribly usable. Fix it here.
         query_hash.each_pair { |k, v| query_hash[k] = v[0] if v.length == 1 }
@@ -68,7 +66,7 @@ module URI
     end
 
     def has_query?
-      %w(http https).include?(@uri.scheme) && query
+      %w[http https].include?(@uri.scheme) && query
     end
 
     def canonicalize!(options = {})
@@ -103,7 +101,7 @@ module URI
           REQUIRE_REGEX_ESCAPE.include?(char) ? "\\#{char}" : char
         end
 
-        Regexp.new("[" + escaped_characters_for_regex.join + "]")
+        Regexp.new("[#{escaped_characters_for_regex.join}]")
       end
     end
 
@@ -124,7 +122,5 @@ module Kernel
   end
   # rubocop:enable Naming/MethodName
 
-  # rubocop:disable Style/AccessModifierDeclarations
   module_function :BLURI
-  # rubocop:enable Style/AccessModifierDeclarations
 end

data/lib/uri/query_hash.rb

@@ -5,7 +5,7 @@ module URI
     def [](key)
       item = super key
       item = super(key.to_s) if item.nil? || item.empty?
-      item.class == Array && item.empty? ? nil : item
+      item.instance_of?(Array) && item.empty? ? nil : item
     end
 
     def to_s

data/optic14n.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-
+require "English"
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "optic14n/version"
@@ -14,14 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/alphagov/optic14n"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.required_ruby_version = ">= 3.1.4"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
 
   spec.add_dependency "addressable", "~> 2.7"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop-govuk", "~> 1.0.0"
+  spec.add_development_dependency "rubocop-govuk", "5.0.2"
 end

data/spec/c14n_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require "spec_helper"
 
 describe "Paul's tests, translated from Perl" do
@@ -67,8 +65,8 @@ describe "Paul's tests, translated from Perl" do
     end
     it "decodes non-reserved characters (! and ~)" do
       # My god, it's full of stars
-      expect(BLURI("http://www.example.com/%7eyes%20I%20have%20now%20read%20%5brfc%203986%5d%2C%20%26%20I%27m%20a%20%3Dlot%3D%20more%20reassured%21%21").
-          canonicalize!.to_s).to eq("http://www.example.com/~yes%20i%20have%20now%20read%20%5brfc%203986%5d%2c%20%26%20i%27m%20a%20%3dlot%3d%20more%20reassured!!")
+      expect(BLURI("http://www.example.com/%7eyes%20I%20have%20now%20read%20%5brfc%203986%5d%2C%20%26%20I%27m%20a%20%3Dlot%3D%20more%20reassured%21%21")
+          .canonicalize!.to_s).to eq("http://www.example.com/~yes%20i%20have%20now%20read%20%5brfc%203986%5d%2c%20%26%20i%27m%20a%20%3dlot%3d%20more%20reassured!!")
     end
     it "encodes pound signs" do
       expect(BLURI("https://www.example.com/pound-sign-£").canonicalize!.to_s).to eq("http://www.example.com/pound-sign-%c2%a3")
@@ -93,8 +91,8 @@ describe "Paul's tests, translated from Perl" do
         )
       end
       it "sorts query string values" do
-        expect(BLURI("http://www.example.com?c=23&d=1&b=909&e=33&a=1").
-          canonicalize!(allow_query: %i[b e c d a]).to_s).to eq("http://www.example.com?a=1&b=909&c=23&d=1&e=33")
+        expect(BLURI("http://www.example.com?c=23&d=1&b=909&e=33&a=1")
+          .canonicalize!(allow_query: %i[b e c d a]).to_s).to eq("http://www.example.com?a=1&b=909&c=23&d=1&e=33")
       end
       it "encodes querystring values" do
         expect(BLURI("http://www.example.com?a=you're_dangerous").canonicalize!(allow_query: :all).to_s).to eq(
@@ -107,16 +105,16 @@ describe "Paul's tests, translated from Perl" do
         )
       end
       it "converts matrix URI to query_string" do
-        expect(BLURI("http://www.example.com?c=23;d=1;b=909;e=33;a=1").
-          canonicalize!(allow_query: %i[b e c d a]).to_s).to eq("http://www.example.com?a=1&b=909&c=23&d=1&e=33")
+        expect(BLURI("http://www.example.com?c=23;d=1;b=909;e=33;a=1")
+          .canonicalize!(allow_query: %i[b e c d a]).to_s).to eq("http://www.example.com?a=1&b=909&c=23&d=1&e=33")
       end
       it "sorts cherry-picked query string arguments" do
-        expect(BLURI("http://www.example.com?a=2322sdfsf&topic=334499&q=909&item=23444").
-          canonicalize!(allow_query: %i[topic item]).to_s).to eq("http://www.example.com?item=23444&topic=334499")
+        expect(BLURI("http://www.example.com?a=2322sdfsf&topic=334499&q=909&item=23444")
+          .canonicalize!(allow_query: %i[topic item]).to_s).to eq("http://www.example.com?item=23444&topic=334499")
       end
       it "ignores empty querystring values" do
-        expect(BLURI("http://www.example.com?a=2322sdfsf&topic=334499&q=909&item=23444").
-          canonicalize!(allow_query: %w(foo bar baz)).to_s).to eq("http://www.example.com")
+        expect(BLURI("http://www.example.com?a=2322sdfsf&topic=334499&q=909&item=23444")
+          .canonicalize!(allow_query: %w[foo bar baz]).to_s).to eq("http://www.example.com")
       end
 
       describe "querystrings that are not an HTML-encoded thing" do
@@ -174,15 +172,15 @@ describe "Paul's tests, translated from Perl" do
       describe "the treatment of query strings when there are query string octets that unescape to "\
                "invalid UTF-8 sequences (we no longer treat these as failures)" do
         it "no longer raises exceptions when there are bad things in query values" do
-          expect(BLURI("http://example.com/path?view=%ED").
-            canonicalize!(allow_query: :all).
-            to_s).to eql("http://example.com/path?view=%ED")
+          expect(BLURI("http://example.com/path?view=%ED")
+            .canonicalize!(allow_query: :all)
+            .to_s).to eql("http://example.com/path?view=%ED")
         end
 
         it "re-encodes correctly when there are bad things in query keys" do
-          expect(BLURI("http://example.com/path?%ED=view").
-            canonicalize!(allow_query: :all).
-            to_s).to eql("http://example.com/path?%ED=view")
+          expect(BLURI("http://example.com/path?%ED=view")
+            .canonicalize!(allow_query: :all)
+            .to_s).to eql("http://example.com/path?%ED=view")
         end
 
         it "does not error when there are bad things in query keys when allow_query isn't :all" do

data/spec/canonicalized_urls_spec.rb

@@ -3,14 +3,14 @@ require "spec_helper"
 describe Optic14n::CanonicalizedUrls do
   describe "c14nize" do
     let(:test_urls) do
-      %w(
+      %w[
         http://www.qhm.mod.uk/portsmouth/leisure/fuel
         http://www.qhm.mod.uk/portsmouth/leisure/lntm?
         http://www.qhm.mod.uk/portsmouth/leisure/lntm?action=view
         http://www.qhm.mod.uk/portsmouth/leisure/lntm?action=view&id=199
         http://unistats.direct.gov.uk/searchResults.do?pname=institutesearchresults&level3Subjects=L3.90%AC10007761%ACFIRSTDEGREE%ACFulltime%AC430%ACNo%AC60%ACYes%AC83%ACNo%ACYes
         1234://123
-      )
+      ]
     end
 
     context "options[:allow_query] is false" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optic14n
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 5.0.2
 description: Canonicalises URLs.
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -73,12 +73,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/autorelease.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".govuk_dependabot_merger.yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
-- Jenkinsfile
-- LICENSE.txt
+- LICENCE
 - README.md
 - Rakefile
 - lib/optic14n.rb
@@ -107,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '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.5.21
 signing_key: 
 specification_version: 4
 summary: Specifically, HTTP URLs, for a limited purpose

data/Jenkinsfile

@@ -1,9 +0,0 @@
-#!/usr/bin/env groovy
-
-library("govuk")
-
-node {
-  govuk.buildProject(
-    rubyLintDiff: false
-  )
-}