Merge pull request #797 from gjtorikian/multiple-mailtos

Support multiple email addresses in `mailto`
gjtorikian · Apr 18, 2023 · df99bc4 · df99bc4 · MinKhant21a · May 20, 2023
2 parents bcc4bac + ad73180
commit df99bc4
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 7 deletions.
diff --git a/Rakefile b/Rakefile
@@ -23,7 +23,7 @@ task :proof_readme do
   require "html-proofer"
   require "redcarpet"
 
-  renderer = Redcarpet::Render::HTML.new(\
+  renderer = Redcarpet::Render::HTML.new(
     with_toc_data: true,
   )
   redcarpet = Redcarpet::Markdown.new(renderer)

diff --git a/lib/html_proofer/check/links.rb b/lib/html_proofer/check/links.rb
@@ -96,7 +96,8 @@ def handle_mailto
             "#{@link.url.raw_attribute} contains no email address",
             element: @link,
           ) unless ignore_empty_mailto?
-        elsif !/#{URI::MailTo::EMAIL_REGEXP}/o.match?(@link.url.path)
+        # eg., if any do not match a valid URL
+        elsif @link.url.path.split(",").any? { |email| !/#{URI::MailTo::EMAIL_REGEXP}/o.match?(email) }
           add_failure(
             "#{@link.url.raw_attribute} contains an invalid email address",
             element: @link,

diff --git a/lib/html_proofer/log.rb b/lib/html_proofer/log.rb
@@ -12,7 +12,7 @@ class Log
 
     def initialize(log_level)
       @logger = Yell.new(
-        format: false, \
+        format: false,
         name: "HTMLProofer", \
         level: "gte.#{log_level}",
       ) do |l|
@@ -41,7 +41,7 @@ def colorize(level, message)
         :red
       end
 
-      if (STDOUT_LEVELS.include?(level) && $stdout.isatty) || \
+      if (STDOUT_LEVELS.include?(level) && $stdout.isatty) ||
           (STDERR_LEVELS.include?(level) && $stderr.isatty)
         Rainbow(message).send(color)
       else

diff --git a/lib/html_proofer/reporter.rb b/lib/html_proofer/reporter.rb
@@ -11,8 +11,8 @@ def initialize(logger: nil)
     end
 
     def failures=(failures)
-      @failures = failures.group_by(&:check_name) \
-        .transform_values { |issues| issues.sort_by { |issue| [issue.path, issue.line] } } \
+      @failures = failures.group_by(&:check_name)
+        .transform_values { |issues| issues.sort_by { |issue| [issue.path, issue.line] } }
         .sort
     end
 

diff --git a/lib/html_proofer/version.rb b/lib/html_proofer/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTMLProofer
-  VERSION = "5.0.6"
+  VERSION = "5.0.7"
 end
diff --git a/spec/html-proofer/fixtures/links/multiple_mailto_links.html b/spec/html-proofer/fixtures/links/multiple_mailto_links.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <a href="mailto:test@test.org,test1@cs.edu,test0@cs.wisc.edu">Mail me</a>.
+  </body>
+</html>
diff --git a/spec/html-proofer/links_spec.rb b/spec/html-proofer/links_spec.rb
@@ -246,6 +246,12 @@
     expect(proofer.failed_checks).to(eq([]))
   end
 
+  it "accepts multiple mailto links" do
+    ignorable_links = File.join(FIXTURES_DIR, "links", "multiple_mailto_links.html")
+    proofer = run_proofer(ignorable_links, :file)
+    expect(proofer.failed_checks).to(eq([]))
+  end
+
   it "ignores blank mailto links when configured to allow them" do
     blank_mail_to_link = File.join(FIXTURES_DIR, "links", "blank_mailto_link.html")
     proofer = run_proofer(blank_mail_to_link, :file, ignore_empty_mailto: true)