Merge pull request #657 from PeterJCLaw/mailto-without-email-ignore

Add flag to allow no-email mailto links

README.md

@@ -319,6 +319,7 @@ The `HTMLProofer` constructor takes an optional hash of additional options:
 | `http_status_ignore` | An array of numbers representing status codes to ignore. | `[]`
 | `internal_domains`| An array of Strings containing domains that will be treated as internal urls. | `[]` |
 | `log_level` | Sets the logging level, as determined by [Yell](https://github.com/rudionrails/yell). One of `:debug`, `:info`, `:warn`, `:error`, or `:fatal`. | `:info`
+| `ignore_empty_mailto` | If `true`, allows `mailto:` `href`s which do not contain an email address. | `false`
 | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
 | `root_dir` | The absolute path to the directory serving your html-files. | "" |
 | `typhoeus_config` | A JSON-formatted string. Parsed using `JSON.parse` and mapped on top of the default configuration values so that they can be overridden. | `{}` |

bin/htmlproofer

@@ -37,6 +37,7 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'file_ignore', '--file-ignore file1,[file2,...]', Array, 'A comma-separated list of Strings or RegExps containing file paths that are safe to ignore'
   p.option 'http_status_ignore', '--http-status-ignore 123,[xxx, ...]', Array, 'A comma-separated list of numbers representing status codes to ignore.'
   p.option 'internal_domains', '--internal-domains domain1,[domain2,...]', Array, 'A comma-separated list of Strings containing domains that will be treated as internal urls.'
+  p.option 'ignore_empty_mailto', '--ignore-empty-mailto', 'If `true`, allows `mailto:` `href`s which do not contain an email address'
   p.option 'report_invalid_tags', '--report-invalid-tags', 'When `check_html` is enabled, HTML markup that is unknown to Nokogumbo are reported as errors (default: `false`)'
   p.option 'report_missing_names', '--report-missing-names', 'When `check_html` is enabled, HTML markup that are missing entity names are reported as errors (default: `false`)'
   p.option 'report_script_embeds', '--report-script-embeds', 'When `check_html` is enabled, `script` tags containing markup are reported as errors (default: `false`)'

lib/html-proofer/cache.rb

@@ -178,7 +178,7 @@ def time_ago(measurement, unit)
       when :months
         @cache_datetime >> -measurement
       when :weeks
-        @cache_datetime - measurement * 7
+        @cache_datetime - (measurement * 7)
       when :days
         @cache_datetime - measurement
       when :hours

lib/html-proofer/check/links.rb

@@ -95,7 +95,7 @@ def check_schemes(link, line, content)
 
   def handle_mailto(link, line, content)
     if link.path.empty?
-      add_issue("#{link.href} contains no email address", line: line, content: content)
+      add_issue("#{link.href} contains no email address", line: line, content: content) unless link.ignore_empty_mailto?
     elsif !link.path.include?('@')
       add_issue("#{link.href} contains an invalid email address", line: line, content: content)
     end

lib/html-proofer/configuration.rb

@@ -27,6 +27,7 @@ module Configuration
       http_status_ignore: [],
       internal_domains: [],
       log_level: :info,
+      ignore_empty_mailto: false,
       only_4xx: false,
       url_ignore: [],
       url_swap: {}

lib/html-proofer/element.rb

@@ -142,6 +142,10 @@ def check_sri?
       @check.options[:check_sri]
     end
 
+    def ignore_empty_mailto?
+      @check.options[:ignore_empty_mailto]
+    end
+
     # path is external to the file
     def external?
       !internal?

spec/html-proofer/links_spec.rb

@@ -200,6 +200,12 @@
     expect(proofer.failed_tests).to eq []
   end
 
+  it 'ignores blank mailto links when configured to allow them' do
+    blank_mail_to_link = "#{FIXTURES_DIR}/links/blank_mailto_link.html"
+    proofer = run_proofer(blank_mail_to_link, :file, ignore_empty_mailto: true)
+    expect(proofer.failed_tests).to eq []
+  end
+
   it 'fails for blank mailto links' do
     blank_mail_to_link = "#{FIXTURES_DIR}/links/blank_mailto_link.html"
     proofer = run_proofer(blank_mail_to_link, :file)