html-proofer-mailto_awesome 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9833f8b94e76e14326e0f45a5db0231477a8384e0d84496265d94f412078716d
-  data.tar.gz: 2ecd2f2141de8b9f56b7a7c85cb11b17ca2f3bc3efb29041217adf019c98c841
+  metadata.gz: 6411236c394f40f47f399843d66e72fd0c23dbeff791b9f424b17b1d3109d00d
+  data.tar.gz: aec40d5251f5ae89c1fb928a22d42c94a4838b0ec10c21ad4cb6701f877690fd
 SHA512:
-  metadata.gz: 33c400bd890f48c071815d5d2dfa14d8892e502c7c72617be6c9525c67dabd4bf13c1a6f66052939ae6eaede31050a726a36a20e84dacac0cb71d8dea7306018
-  data.tar.gz: 3953271fb34870739b71a4a37976e853c54feb9408a6df6a4355e70d017dd374011e6ce1bd6da9dd2edf9fbca08230f60cae573415d520fbc655f24e09767b3c
+  metadata.gz: 1656ce1159562e5a4247f852f69290f8442dea492d842dcbc82e79c828edb9a5e18d36b71a8b6474c63c8d3bc4d69609ffd17efa752f204a75a58972cd3bd85d
+  data.tar.gz: e7d4983774757825b40c346932b736790a2f1553027f4995c50cc79902043523f7433dab3c2e963ab948e15f85a095223d7a9ee33110b1e8a1f5bc61ec17ec1b

data/.editorconfig

@@ -0,0 +1,13 @@
+# UTF-8, LF, and spaces. Trailing whitespace is kept so a Markdown hard break (two spaces) stays intact.
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = false
+max_line_length = 120
+
+[*.md]
+max_line_length = off

data/.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Lint
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    # Runs on all pull requests targeting any branch
+    branches: ["**"]
+
+jobs:
+  lint:
+    name: Prettier & Markdownlint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Setup Node.js (tool runtime)
+        uses: actions/setup-node@v7
+        with:
+          node-version: "lts/*" # Floating version is appropriate specifically for Prettier and markdownlint
+
+      - name: Check formatting (Prettier)
+        # Command fails if any files do not meet the formatting rules.
+        run: npx prettier@latest --check .
+
+      - name: Check Markdown (markdownlint)
+        # Command fails if any markdown files do not meet the linting rules.
+        run: npx markdownlint-cli@latest "**/*.md" --ignore "node_modules"

data/.github/workflows/ruby.yml

@@ -1,36 +1,37 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+# Ruby branches still in normal or security maintenance:
+# https://www.ruby-lang.org/en/downloads/branches/
 
-name: Ruby
+name: Test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["**"]
 
 permissions:
   contents: read
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
-      matrix:
-        # Only test currently supported Ruby versions: https://www.ruby-lang.org/en/downloads/branches/
-        ruby-version: ['3.1', '3.2', '3.3']
       fail-fast: false
+      matrix:
+        ruby-version: ["3.3", "3.4", "4.0"]
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -1,3 +1,5 @@
+.DS_Store
+
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -9,4 +11,7 @@
 
 # rspec failure tracking
 .rspec_status
-/vendor/*
+/vendor/*
+
+# The lint workflow runs npx, which can leave a local install tree.
+node_modules/

data/.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "MD013": false
+}

data/.prettierignore

@@ -0,0 +1 @@
+*.md

data/Gemfile.lock

@@ -1,21 +1,22 @@
 PATH
   remote: .
   specs:
-    html-proofer-mailto_awesome (2.0.0)
+    html-proofer-mailto_awesome (2.1.0)
       html-proofer (~> 5.0, >= 5.0.4)
+      logger
 
 GEM
   remote: https://rubygems.org/
   specs:
     Ascii85 (2.0.1)
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     afm (0.2.2)
     async (2.21.2)
       console (~> 1.29)
       fiber-annotation
       io-event (~> 1.6, >= 1.6.5)
-    base64 (0.3.0)
+    benchmark (0.5.0)
     bigdecimal (3.2.3)
     console (1.30.2)
       fiber-annotation
@@ -24,22 +25,23 @@ GEM
     diff-lcs (1.6.2)
     ethon (0.15.0)
       ffi (>= 1.15.0)
-    ffi (1.17.2-aarch64-linux-gnu)
-    ffi (1.17.2-aarch64-linux-musl)
-    ffi (1.17.2-arm-linux-gnu)
-    ffi (1.17.2-arm-linux-musl)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
-    ffi (1.17.2-x86_64-linux-musl)
+    ffi (1.17.4-aarch64-linux-gnu)
+    ffi (1.17.4-aarch64-linux-musl)
+    ffi (1.17.4-arm-linux-gnu)
+    ffi (1.17.4-arm-linux-musl)
+    ffi (1.17.4-arm64-darwin)
+    ffi (1.17.4-x86_64-darwin)
+    ffi (1.17.4-x86_64-linux-gnu)
+    ffi (1.17.4-x86_64-linux-musl)
     fiber-annotation (0.2.0)
     fiber-local (1.1.0)
       fiber-storage
     fiber-storage (1.0.1)
     hashery (2.1.2)
-    html-proofer (5.0.10)
+    html-proofer (5.2.2)
       addressable (~> 2.3)
       async (~> 2.1)
+      benchmark (~> 0.5)
       nokogiri (~> 1.13)
       pdf-reader (~> 2.11)
       rainbow (~> 3.0)
@@ -47,22 +49,23 @@ GEM
       yell (~> 2.0)
       zeitwerk (~> 2.5)
     io-event (1.11.2)
-    json (2.14.1)
-    nokogiri (1.18.10-aarch64-linux-gnu)
+    json (2.15.2.1)
+    logger (1.7.0)
+    nokogiri (1.19.4-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.10-aarch64-linux-musl)
+    nokogiri (1.19.4-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.10-arm-linux-gnu)
+    nokogiri (1.19.4-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.10-arm-linux-musl)
+    nokogiri (1.19.4-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.10-arm64-darwin)
+    nokogiri (1.19.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.10-x86_64-darwin)
+    nokogiri (1.19.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.10-x86_64-linux-gnu)
+    nokogiri (1.19.4-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.10-x86_64-linux-musl)
+    nokogiri (1.19.4-x86_64-linux-musl)
       racc (~> 1.4)
     pdf-reader (2.15.0)
       Ascii85 (>= 1.0, < 3.0, != 2.0.0)
@@ -88,13 +91,10 @@ GEM
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
     ruby-rc4 (0.1.5)
-    timecop (0.9.10)
     ttfunk (1.8.0)
       bigdecimal (~> 3.1)
     typhoeus (1.5.0)
       ethon (>= 0.9.0, < 0.16.0)
-    vcr (6.3.1)
-      base64
     yell (2.2.2)
     zeitwerk (2.6.18)
 
@@ -113,8 +113,6 @@ DEPENDENCIES
   html-proofer-mailto_awesome!
   rake (>= 13.0)
   rspec (~> 3.12)
-  timecop (~> 0.9)
-  vcr (~> 6.1)
 
 BUNDLED WITH
    2.6.9

data/README.md

@@ -1,80 +1,140 @@
-![Gem](https://img.shields.io/gem/v/html-proofer-mailto_awesome) [![Ruby](https://github.com/fulldecent/html-proofer-mailto_awesome/actions/workflows/ruby.yml/badge.svg)](https://github.com/fulldecent/html-proofer-mailto_awesome/actions/workflows/ruby.yml)
-
 # html-proofer-mailto_awesome
-A custom [html-proofer](https://github.com/gjtorikian/html-proofer) test that makes your `mailto:` links awesome.
 
-## What is an awesome `mailto` link?
+![Gem](https://img.shields.io/gem/v/html-proofer-mailto_awesome) [![Test](https://github.com/fulldecent/html-proofer-mailto_awesome/actions/workflows/ruby.yml/badge.svg)](https://github.com/fulldecent/html-proofer-mailto_awesome/actions/workflows/ruby.yml) [![Lint](https://github.com/fulldecent/html-proofer-mailto_awesome/actions/workflows/lint.yml/badge.svg)](https://github.com/fulldecent/html-proofer-mailto_awesome/actions/workflows/lint.yml)
+
+An [html-proofer](https://github.com/gjtorikian/html-proofer) check that requires `mailto:` links to carry the header fields you want every message to start with.
+
+## What an awesome mailto link is
 
-We should use awesome links as psychological warfare against users. Users will send us emails with stupid or annoying content that we don't want. At big companies (like Amazon) they have abandoned email altogether because of this reason. So instead we prefill the email with the message we want to receive. It takes active cognitive effort for the user to put in their unwanted message.
+People send email we did not ask for. A bare `mailto:` link opens a blank message, and the sender fills that blank with whatever is on their mind. Prefilling the subject and the body makes the useful message the path of least resistance. Replacing it takes effort.
 
-❌ For example, this is a not-awesome `mailto` link:
+This is a not-awesome link:
 
 ```html
 <a href="mailto:support@pacificmedicaltraining.com">Email us</a>
 ```
 
-✅ This is an awesome link:
+This is an awesome link. The subject and the body are already there:
 
 ```html
-<a href="mailto:support@pacificmedicaltraining.com?subject=Signing up&amp;body=Hello,\nI'd like to sign up for your course, can you please send me more information.">Email us</a>
+<a
+  href="mailto:support@pacificmedicaltraining.com?subject=Signing%20up&amp;body=Hello%2C%0AI%20would%20like%20to%20sign%20up."
+>
+  Email us
+</a>
+```
+
+[RFC 6068](https://www.rfc-editor.org/rfc/rfc6068) is the `mailto:` URI scheme. In HTML, write `&amp;` for an ampersand inside the attribute. Header field names are case-insensitive. `Subject` and `subject` are the same field.
+
+The same rule is published for HTML-validate as [`nice-checkers/mailto-awesome`](https://github.com/fulldecent/html-validate-nice-checkers#nice-checkersmailto-awesome).
+
+## Installation
+
+This gem runs on the Ruby branches that are still in normal or security maintenance: 3.3, 3.4, and 4.0. The list is [Ruby maintenance branches](https://www.ruby-lang.org/en/downloads/branches/). Install one of those Rubies from that page.
+
+Add the gem to the application that builds or checks the site:
+
+```ruby
+gem "html-proofer-mailto_awesome"
+```
+
+Then install:
+
+```sh
+bundle install
+```
+
+## Usage
+
+html-proofer runs only the checks named in `checks`. That option replaces the default list, which is `Links`, `Images`, and `Scripts`. Include those names when you still want them, and add `MailtoAwesome`.
+
+Require this gem before `run`. html-proofer discovers the check by looking at classes that are already loaded.
+
+```ruby
+require "html-proofer"
+require "html-proofer-mailto_awesome"
+
+desc "Check the built site"
+task :test do
+  HTMLProofer.check_directory("_site", {
+    checks: ["Links", "Images", "Scripts", "MailtoAwesome"],
+  }).run
+end
+
+task default: :test
 ```
 
-For more reference, see http://marcwitteveen.com/mailtogenerator/
+Run it with Bundler so the gem is on the load path:
 
-## How do I use it
+```sh
+bundle exec rake
+```
 
-Follow the same instructions as for any [html-proofer custom class](https://github.com/gjtorikian/html-proofer/wiki/Extensions-(custom-classes)).
+`MailtoAwesome` looks at `a` elements. A `mailto:` link passes when every required header field is present. The default required fields are `subject` and `body`. An empty value still counts as present (`subject=`). Text in the address, such as `mailto:subject=trick@example.com`, is not a header field.
 
-Our ruby gem is [html-proofer-mailto_awesome](https://rubygems.org/gems/html-proofer-mailto_awesome)
+A link that omits a field fails with `mailto: link is missing required parameters: subject, body`. A `mailto:` value that Ruby cannot parse as a URI fails with `mailto: link is malformed and could not be parsed.`
 
-1. Add new dependency to your Ruby project
-  
-    In Gemfile:
-        
-         gem 'html-proofer-mailto_awesome'
-    
-    Or in your .gemspec: 
+`data-proofer-ignore` skips the link, as it does for the other html-proofer checks.
 
-         Gem::Specification.new do |s|
-             ...
-             s.add_runtime_dependency 'html-proofer-mailto_awesome'
-         end
-    
-2. Create a Rakefile like the following and add it to your project
+## Configuration
 
-       task :default => [:test]
-       
-       desc 'run Rspec specs'
-       task :test do
-         sh 'rspec spec'
-       end
-  
-3. Run `bundle install`
+`mailto_awesome.required_parameters` replaces the default list. This matches the HTML-validate rule, which uses `requiredParameters` for the same purpose. Pass an empty array when you want the check loaded and no fields required.
 
-4. Run `rake`
+```ruby
+HTMLProofer.check_directory("_site", {
+  checks: ["Links", "Images", "Scripts", "MailtoAwesome"],
+  mailto_awesome: {
+    required_parameters: ["subject", "body"],
+  },
+}).run
+```
 
-Also if you like, you can enable your project for continuous integration testing with Travis:
+## Development
 
-1. Set up Travis CI for your project
+Clone the repository and install the gems it uses to test itself:
 
-2. Add a `.travis.yml` file like the following to your project and your spec will run automatically
+```sh
+git clone https://github.com/fulldecent/html-proofer-mailto_awesome.git
+cd html-proofer-mailto_awesome
+bundle install
+bundle exec rake
+```
 
-       language: ruby
-       rvm:
-         - 2.5.3       
-For additional tests you can run on your website, see [Lightning Sites](https://github.com/fulldecent/lightning-sites) and for a sample GitHub project that implements this testing and follows many other HTML development best practices, see [HTML Website Template](https://github.com/fulldecent/html-website-template).
+Format the files the lint workflow checks. These commands call `@latest` on purpose. A pinned copy would let your machine rewrite files one way and continuous integration reject them another way. [node.js-template](https://github.com/fulldecent/node.js-template) records that constraint on its `format` script.
 
-For a full example of a website project that includes testing  continuous integration testing for awesome mailto links and many other best practices, see our 
-       
-## Contributing
+```sh
+npx prettier@latest --write .
+npx markdownlint-cli@latest --fix "**/*.md" --ignore node_modules
+```
 
-This project is released under the MIT license.
+`*.md` is in `.prettierignore`. Prettier does not wrap Markdown. markdownlint does, and [`.markdownlint.json`](.markdownlint.json) turns off the line-length rule.
 
-Releasing new versions:
+## Releasing
 
 ```sh
-gem bump
-rm html-proofer-mailto_awesome-*.gem
+gem install bump
+bump patch   # or minor, or major
+rm -f html-proofer-mailto_awesome-*.gem
 gem build html-proofer-mailto_awesome.gemspec
 gem push html-proofer-mailto_awesome-*.gem
 ```
+
+Rubygems requires MFA for this gem (`rubygems_mfa_required`).
+
+## Maintenance
+
+Do this every month or so:
+
+1. Read [Ruby maintenance branches](https://www.ruby-lang.org/en/downloads/branches/). Update `required_ruby_version` and the Ruby matrix in [`.github/workflows/ruby.yml`](.github/workflows/ruby.yml) when a branch leaves security maintenance, or when a new branch enters normal maintenance.
+1. Review external actions in [`.github/workflows`](.github/workflows). GitHub-supported actions, the ones under the `actions/` organization, need a short review. `ruby/setup-ruby` is not one of those. Read its changelog before moving the tag.
+1. Review `html-proofer` against the [5.x releases](https://github.com/gjtorikian/html-proofer/releases). This gem depends on `~> 5.0`, `>= 5.0.4`. It also depends on `logger`, because [Ruby 4.0 removed that library from the default gems](https://stdgems.org/libraries/logger/) and html-proofer still loads it.
+1. Keep `ffi` at 1.17.4 or newer, and `nokogiri` at 1.19.0 or newer, in `Gemfile.lock`. The x86_64-linux builds of ffi 1.17.2 and nokogiri 1.18.10 set `required_ruby_version` to `< 3.5.dev`, so `bundle install` fails on Ruby 4.0. ffi 1.17.4 and nokogiri 1.19.4 allow Ruby before 4.1. ethon pulls in ffi. html-proofer pulls in nokogiri.
+
+## References
+
+1. We use title case for titles and proper nouns; not for headings and things. This includes our README above as well as our workflow rules and other configuration files. If you have a different policy, then please implement it throughout.
+1. This project is released under the [MIT license](LICENSE).
+1. This project is built based on [best practices documented in node.js-template](https://github.com/fulldecent/node.js-template). We took its lint workflow (Prettier and markdownlint, both invoked as `npx @latest`), [`.editorconfig`](.editorconfig), [`.markdownlint.json`](.markdownlint.json), [`.prettierignore`](.prettierignore), and this references section. We did not take its Yarn install or its `.node-version` pin. This is a Ruby gem. The lint job uses Node only as the tool runtime for those two checkers.
+1. The check follows [`nice-checkers/mailto-awesome`](https://github.com/fulldecent/html-validate-nice-checkers#nice-checkersmailto-awesome) in [@fulldecent/nice-checkers-plugin](https://github.com/fulldecent/html-validate-nice-checkers): default required fields are `subject` and `body`, and the caller can replace that list. Delta: this gem compares header field names case-insensitively because [RFC 6068 section 2](https://www.rfc-editor.org/rfc/rfc6068#section-2) says `<hfname>` is case-insensitive. The HTML-validate rule uses `URLSearchParams`, which compares names case-sensitively.
+1. html-proofer custom checks are loaded by class name and selected with the `checks` option. Passing `checks` replaces the default list. That behavior is documented in the [html-proofer README](https://github.com/gjtorikian/html-proofer#custom-tests).
+1. Ruby versions in the gemspec and in continuous integration are the branches still in normal or security maintenance, from [Ruby maintenance branches](https://www.ruby-lang.org/en/downloads/branches/). Ruby 4.0 does not ship `logger` as a default gem. This gem depends on the [`logger` gem](https://stdgems.org/libraries/logger/) so html-proofer can load on that Ruby.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "html/proofer/mailto_awesome"
+require "html-proofer-mailto_awesome"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/html-proofer-mailto_awesome.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Minimum Ruby version supported by the Ruby project: https://www.ruby-lang.org/en/downloads/branches/
-  spec.required_ruby_version = ">= 3.1.0"
+  # Ruby branches that are still in normal or security maintenance:
+  # https://www.ruby-lang.org/en/downloads/branches/
+  spec.required_ruby_version = ">= 3.3.0"
   
   spec.metadata = {
     "bug_tracker_uri"   => "https://github.com/fulldecent/html-proofer-mailto_awesome/issues",
@@ -31,10 +32,11 @@ Gem::Specification.new do |spec|
     "rubygems_mfa_required" => "true"
   }
 
+  spec.add_dependency "html-proofer", "~> 5.0", ">= 5.0.4"
+  # Ruby 4.0 removed logger from the default gems. html-proofer still loads it.
+  # https://stdgems.org/libraries/logger/
+  spec.add_dependency "logger"
   spec.add_development_dependency "bundler", ">= 2.0"
   spec.add_development_dependency "rake", ">= 13.0"
-  spec.add_runtime_dependency 'html-proofer', '~> 5.0', '>= 5.0.4'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'vcr', '~> 6.1'
-  spec.add_development_dependency 'timecop', '~> 0.9'
+  spec.add_development_dependency "rspec", "~> 3.12"
 end

data/lib/html/proofer/mailto_awesome/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailtoAwesome
-  VERSION = "2.0.0"
-end
+  VERSION = "2.1.0"
+end

data/lib/html-proofer-mailto_awesome.rb

@@ -1,10 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "html/proofer/mailto_awesome/version"
 require_relative "mailto_awesome"
-
-module HTMLProofer
-  module MailtoAwesome
-    class Error < StandardError; end
-  end
-end

data/lib/mailto_awesome.rb

@@ -1,31 +1,60 @@
 # frozen_string_literal: true
 
 require "html/proofer/mailto_awesome/version"
+# Ruby 4.0 removed logger from the default gems. html-proofer still loads it.
+# https://stdgems.org/libraries/logger/
+require "logger"
+require "html-proofer"
+require "uri"
 
 module HTMLProofer
   class Check
+    # Reports mailto links that omit the header fields a recipient asked for.
+    # Header field names follow RFC 6068: hfname is case-insensitive.
+    # https://www.rfc-editor.org/rfc/rfc6068#section-2
     class MailtoAwesome < HTMLProofer::Check
-      def mailto?
-        return false if @link.ignore? || @link.href.nil?
-        @link.href.match(/^mailto:/i)
-      end
-    
-      def awesome?
-        @link.href.downcase.include?('subject=') && @link.href.downcase.include?('body=')
-      end
-    
+      DEFAULT_REQUIRED_PARAMETERS = ["subject", "body"].freeze
+
       def run
-        # Check if the mailto awesome check is enabled via runner options
-        return unless @runner && @runner.instance_variable_get('@options')&.fetch(:check_mailto_awesome, false)
-        
-        @html.css('a').each do |node|
+        @html.css("a").each do |node|
           @link = create_element(node)
-    
-          if mailto? && !awesome?
-            add_failure("This is a not-awesome mailto link!", element: @link)
+          next if @link.ignore?
+
+          href = node["href"]
+          next unless href.is_a?(String) && href.match?(/\Amailto:/i)
+
+          begin
+            names = header_names(href)
+          rescue URI::InvalidURIError
+            add_failure("mailto: link is malformed and could not be parsed.", element: @link)
+            next
           end
+
+          missing = required_parameters.reject { |name| names.include?(name) }
+          next if missing.empty?
+
+          add_failure("mailto: link is missing required parameters: #{missing.join(", ")}", element: @link)
         end
       end
+
+      private
+
+      def required_parameters
+        configured = @runner.options[:mailto_awesome]
+        names = configured[:required_parameters] || configured["required_parameters"] if configured.is_a?(Hash)
+        names = DEFAULT_REQUIRED_PARAMETERS if names.nil?
+        Array(names).map { |name| name.to_s.downcase }
+      end
+
+      def header_names(href)
+        # Nokogiri has already decoded &amp;. A caller that passes the source
+        # text still has the entity, which RFC 6068 requires in HTML.
+        semantic = href.gsub("&amp;", "&").gsub("&lt;", "<").gsub("&gt;", ">")
+        uri = URI.parse(semantic)
+        raise URI::InvalidURIError, semantic unless uri.is_a?(URI::MailTo)
+
+        Array(uri.headers).map { |name, _value| name.to_s.downcase }
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer-mailto_awesome
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - William Entriken
@@ -10,104 +10,94 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: html-proofer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
+        version: 5.0.4
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 5.0.4
 - !ruby/object:Gem::Dependency
-  name: html-proofer
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.12'
 description: A custom html-proofer test that makes your mailto links awesome
 email: github.com@phor.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".github/FUNDING.yml"
+- ".github/workflows/lint.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".markdownlint.json"
+- ".prettierignore"
 - ".rspec"
 - Gemfile
 - Gemfile.lock
@@ -135,14 +125,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Checker for mailto links
 test_files: []