Modernize gem (#19)

* Migrate tests from `rspec` -> `sus`.

* Add `utopia-project` for documentation.

.editorconfig

@@ -3,3 +3,7 @@ root = true
 [*]
 indent_style = tab
 indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.github/workflows/coverage.yaml

@@ -0,0 +1,57 @@
+name: Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  COVERAGE: PartialSummary
+
+jobs:
+  test:
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+
+        ruby:
+          - "3.3"
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+
+    - name: Run tests
+      timeout-minutes: 5
+      run: bundle exec bake test
+
+    - uses: actions/upload-artifact@v3
+      with:
+        name: coverage-${{matrix.os}}-${{matrix.ruby}}
+        path: .covered.db
+
+  validate:
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.3"
+        bundler-cache: true
+
+    - uses: actions/download-artifact@v3
+
+    - name: Validate coverage
+      timeout-minutes: 5
+      run: bundle exec bake covered:validate --paths */.covered.db \;

.github/workflows/documentation.yaml

@@ -0,0 +1,58 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment:
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  BUNDLE_WITH: maintenance
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.3"
+        bundler-cache: true
+
+    - name: Installing packages
+      run: sudo apt-get install wget
+
+    - name: Generate documentation
+      timeout-minutes: 5
+      run: bundle exec bake utopia:project:static --force no
+
+    - name: Upload documentation artifact
+      uses: actions/upload-pages-artifact@v2
+      with:
+        path: docs
+
+  deploy:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+
+    needs: generate
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3

.github/workflows/test-external.yaml

@@ -0,0 +1,37 @@
+name: Test External
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+
+jobs:
+  test:
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+
+        ruby:
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+
+    - name: Run tests
+      timeout-minutes: 10
+      run: bundle exec bake test:external

.github/workflows/development.yml → .github/workflows/test.yaml

@@ -1,12 +1,12 @@
-name: Development
+name: Test
 
 on: [push, pull_request]
 
 permissions:
   contents: read
 
 env:
-  CONSOLE_OUTPUT: Text
+  CONSOLE_OUTPUT: XTerm
 
 jobs:
   test:
@@ -21,9 +21,10 @@ jobs:
           - macos
 
         ruby:
-          - "2.7"
           - "3.0"
           - "3.1"
+          - "3.2"
+          - "3.3"
 
         experimental: [false]
 
@@ -39,12 +40,12 @@ jobs:
             experimental: true
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}
         bundler-cache: true
 
     - name: Run tests
-      timeout-minutes: 5
-      run: bundle exec rspec
+      timeout-minutes: 10
+      run: bundle exec bake test

.gitignore

@@ -1,19 +1,5 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+/.bundle/
+/pkg/
 /gems.locked
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.tags*
-.rspec_status
+/.covered.db
+/external

config/sus.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'covered/sus'
+include Covered::Sus

gems.rb

@@ -1,10 +1,23 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2022-2024, by Samuel Williams.
+
 source "https://rubygems.org"
 
 gemspec
 
 group :maintenance, optional: true do
 	gem "bake-modernize"
 	gem "bake-gem"
+
+	gem "utopia-project"
+end
+
+group :test do
+	gem "bake-test"
+	gem "bake-test-external"
+
+	gem "sus"
+	gem "covered"
 end

http-accept.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
 	spec.version = HTTP::Accept::VERSION
 
 	spec.summary = "Parse Accept and Accept-Language HTTP headers."
-	spec.authors = ["Samuel Williams", "Matthew Kerwin", "Alif Rachmawadi", "Andy Brody", "Khaled Hassan Hussein", "Olle Jonsson", "Robert Pritzkow"]
+	spec.authors = ["Samuel Williams", "Matthew Kerwin", "Alif Rachmawadi", "Andy Brody", "Ian Oxley", "Khaled Hassan Hussein", "Olle Jonsson", "Robert Pritzkow"]
 	spec.license = "MIT"
 
 	spec.cert_chain  = ['release.cert']
@@ -19,9 +19,7 @@ Gem::Specification.new do |spec|
 		"funding_uri" => "https://github.com/sponsors/ioquatix/",
 	}
 
-	spec.files = Dir.glob('{lib}/**/*', File::FNM_DOTMATCH, base: __dir__)
+	spec.files = Dir.glob(['{lib}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)
 
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "rspec", "~> 3.0"
+	spec.required_ruby_version = ">= 3.0"
 end

lib/http/accept.rb

@@ -1,24 +1,9 @@
 # frozen_string_literal: true
-#
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
+# Copyright, 2016, by Matthew Kerwin.
+# Copyright, 2017, by Andy Brody.
 
 require_relative 'accept/version'
 

lib/http/accept/charsets.rb

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
-#
-# Copyright (C) 2016, Matthew Kerwin <matthew@kerwin.net.au>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+
+# Released under the MIT License.
+# Copyright, 2016, by Matthew Kerwin.
+# Copyright, 2017-2024, by Samuel Williams.
 
 require 'strscan'
 

lib/http/accept/content_type.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
-#
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
 
 require_relative 'media_types'
 require_relative 'quoted_string'