html-proofer 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f952166651bac28c33d10ed6aa595797ecadcc6
-  data.tar.gz: a0f9677119b32b2191b4e749a141c902f21f804e
+  metadata.gz: 5e5d2a78c7071f5534b4fb0d22c34337d9b92a6c
+  data.tar.gz: 4e89db1b52488116724d07608297d3abfb6581bb
 SHA512:
-  metadata.gz: f293738658311d6e823917b9ede779d0314c0c3521e7b48629eec0ad2360952105626095984daf7126f6170d799b03f903553b2d7bd83b3a01e92de8d0a42f63
-  data.tar.gz: 5945181a2600773c2102a7b256504cbc9902fa3645b53e4f73e6b46ea41422d73c79295f3012db6d76c44d46d2b1dda9ad639ee75f2515ce2142d4ea82e08d77
+  metadata.gz: 84e99216d622692010d127c80f4cf4a128b5391535169418a9715d99f1d0ccdfcbe3edf976ee769ce2d5021b1989c6e232d00de72ae8574f82eb29b925a0e269
+  data.tar.gz: 57e675836bb4a138dcfd84a0751772bbd99d05d3605dc8c1f922197683fe92a65563f0618393720a5ed3f44101025977f94f2dbf7cba96161def098148ad98ce

data/.travis.yml

@@ -7,9 +7,6 @@ rvm:
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-addons:
-  code_climate:
-    repo_token:
 
 sudo: false
 cache: bundler

data/Gemfile

@@ -1,5 +1,3 @@
 source 'http://rubygems.org'
 
 gemspec
-
-gem 'codeclimate-test-reporter', :group => :test, :require => nil

data/README.md

@@ -4,7 +4,7 @@ If you generate HTML files, _then this tool might be for you_.
 
 `HTML::Proofer` is a set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your output.
 
-[![Build Status](https://travis-ci.org/gjtorikian/html-proofer.svg?branch=master)](https://travis-ci.org/gjtorikian/html-proofer) [![Gem Version](https://badge.fury.io/rb/html-proofer.svg)](http://badge.fury.io/rb/html-proofer) [![Test Coverage](https://codeclimate.com/github/gjtorikian/html-proofer/badges/coverage.svg)](https://codeclimate.com/github/gjtorikian/html-proofer)
+[![Build Status](https://travis-ci.org/gjtorikian/html-proofer.svg?branch=master)](https://travis-ci.org/gjtorikian/html-proofer) [![Gem Version](https://badge.fury.io/rb/html-proofer.svg)](http://badge.fury.io/rb/html-proofer)
 
 ## Installation
 
@@ -149,6 +149,7 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored. | `[]` |
 | `href_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. | `{}` |
 | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
+| `url_ignore` | An array of Strings or RegExps containing URLs that are safe to ignore. It affects all HTML attributes. Note that non-HTTP(S) URIs are always ignored. | `[]` |
 | `check_favicon` | Enables the favicon checker. | `false` |
 | `check_html` | Enables HTML validation errors from Nokogiri | `false` |
 | `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` |
@@ -237,3 +238,28 @@ class MailToOctocat < ::HTML::Proofer::CheckRunner
   end
 end
 ```
+
+## Troubleshooting
+
+### Certificates
+
+To ignore certificates turn off the Typhoeus SSL verification:
+
+``` ruby
+HTML::Proofer.new("out/", {
+  :typhoeus => {
+    :ssl_verifypeer => false,
+    :ssl_verifyhost => 0}
+}).run
+```
+
+### User-Agent
+
+To change the User-Agent used by Typhoeus:
+
+``` ruby
+HTML::Proofer.new("out/", {
+  :typhoeus => {
+    :headers => { "User-Agent" => "Mozilla/5.0 (compatible; My New User-Agent)" }
+}}).run
+```

data/lib/html/proofer.rb

@@ -39,6 +39,7 @@ module HTML
         :href_swap => [],
         :href_ignore => [],
         :file_ignore => [],
+        :url_ignore => [],
         :check_external_hash => false,
         :alt_ignore => [],
         :empty_alt_ignore => false,

data/lib/html/proofer/check_runner.rb

@@ -6,7 +6,7 @@ module HTML
     class CheckRunner
 
       attr_reader :issues, :src, :path, :options, :typhoeus_opts, :hydra_opts, :parallel_opts, \
-                  :external_urls, :href_ignores, :alt_ignores, :empty_alt_ignore
+                  :external_urls, :href_ignores, :url_ignores, :alt_ignores, :empty_alt_ignore
 
       def initialize(src, path, html, options, typhoeus_opts, hydra_opts, parallel_opts)
         @src    = src
@@ -18,6 +18,7 @@ module HTML
         @parallel_opts = parallel_opts
         @issues = []
         @href_ignores = @options[:href_ignore]
+        @url_ignores = @options[:url_ignore]
         @alt_ignores = @options[:alt_ignore]
         @empty_alt_ignore = @options[:empty_alt_ignore]
         @external_urls = {}

data/lib/html/proofer/checkable.rb

@@ -13,7 +13,7 @@ module HTML
           instance_variable_set("@#{attribute.tr('-:', '_')}".to_sym, value.value)
         end
 
-        @content = obj.content
+        @text = obj.content
         @check = check
         @checked_paths = {}
         @type = self.class.name
@@ -66,13 +66,21 @@ module HTML
       def ignore?
         return true if @data_proofer_ignore
 
-        case @type
-        when 'FaviconCheckable'
+        # ignore base64 encoded images
+        if %w(ImageCheckable FaviconCheckable).include? @type
           return true if url.match(/^data:image/)
-        when 'LinkCheckable'
+        end
+
+        # ignore user defined URLs
+        return true if ignores_pattern_check(@check.url_ignores)
+
+        # ignore user defined hrefs
+        if 'LinkCheckable' === @type
           return true if ignores_pattern_check(@check.href_ignores)
-        when 'ImageCheckable'
-          return true if url.match(/^data:image/)
+        end
+
+        # ignore user defined alts
+        if 'ImageCheckable' === @type
           return true if ignores_pattern_check(@check.alt_ignores)
         end
       end

data/lib/html/proofer/checks/scripts.rb

@@ -11,7 +11,7 @@ class ScriptCheckable < ::HTML::Proofer::Checkable
   end
 
   def blank?
-    @content.strip.empty?
+    @text.strip.empty?
   end
 
 end

data/lib/html/proofer/version.rb

@@ -1,6 +1,6 @@
 module HTML
   class Proofer
-    VERSION = '2.2.0'
+    VERSION = '2.3.0'
   end
 end
 

data/spec/html/proofer/checkable_spec.rb

@@ -2,10 +2,46 @@ require 'spec_helper'
 
 describe HTML::Proofer::Checkable do
   describe '#initialize' do
-    it 'accepts xmlns attribute' do
+    it 'accepts the xmlns attribute' do
       nokogiri = Nokogiri::HTML '<a xmlns:cc="http://creativecommons.org/ns#">Creative Commons</a>'
       checkable = HTML::Proofer::Checkable.new nokogiri.css('a').first, nil
       expect(checkable.instance_variable_get(:@xmlns_cc)).to eq 'http://creativecommons.org/ns#'
     end
+    it 'assignes the text node' do
+      nokogiri = Nokogiri::HTML '<p>One'
+      checkable = HTML::Proofer::Checkable.new nokogiri.css('p').first, nil
+      expect(checkable.instance_variable_get(:@text)).to eq 'One'
+    end
+    it 'accepts the content attribute' do
+      nokogiri = Nokogiri::HTML '<meta name="twitter:card" content="summary">'
+      checkable = HTML::Proofer::Checkable.new nokogiri.css('meta').first, nil
+      expect(checkable.instance_variable_get(:@content)).to eq 'summary'
+    end
+  end
+  describe '#ignores_pattern_check' do
+    it 'works for regex patterns' do
+      nokogiri = Nokogiri::HTML '<script src=/assets/main.js></script>'
+      checkable = HTML::Proofer::Checkable.new nokogiri.css('script').first, nil
+      expect(checkable.ignores_pattern_check([/\/assets\/.*(js|css|png|svg)/])).to eq true
+    end
+    it 'works for string patterns' do
+      nokogiri = Nokogiri::HTML '<script src=/assets/main.js></script>'
+      checkable = HTML::Proofer::Checkable.new nokogiri.css('script').first, nil
+      expect(checkable.ignores_pattern_check(['/assets/main.js'])).to eq true
+    end
+  end
+  describe '#url' do
+    it 'works for src attributes' do
+      nokogiri = Nokogiri::HTML '<img src=image.png />'
+      checkable = HTML::Proofer::Checkable.new nokogiri.css('img').first, nil
+      expect(checkable.url).to eq 'image.png'
+    end
+  end
+  describe '#ignore' do
+    it 'works for twitter cards' do
+      nokogiri = Nokogiri::HTML '<meta name="twitter:url" data-proofer-ignore content="http://example.com/soon-to-be-published-url">'
+      checkable = HTML::Proofer::Checkable.new nokogiri.css('meta').first, nil
+      expect(checkable.ignore?).to eq true
+    end
   end
 end

data/spec/html/proofer/fixtures/scripts/ignorableLinksViaOptions.html

@@ -0,0 +1,4 @@
+<html>
+<head>
+  <script src="/assets/main.js"></script>
+<body>

data/spec/html/proofer/scripts_spec.rb

@@ -38,4 +38,10 @@ describe 'Scripts test' do
     expect(proofer.failed_tests).to eq []
   end
 
+  it 'ignores links via url_ignore' do
+    ignorableLinks = "#{FIXTURES_DIR}/scripts/ignorableLinksViaOptions.html"
+    proofer = run_proofer(ignorableLinks, { :url_ignore => [/\/assets\/.*(js|css|png|svg)/] })
+    expect(proofer.failed_tests).to eq []
+  end
+
 end

data/spec/html/proofer_spec.rb

@@ -68,9 +68,9 @@ describe HTML::Proofer do
         expect(output.strip).to eq('''
 - -1
   *  spec/html/proofer/fixtures/sorting/status/broken_link.html: internally linking to nowhere.fooof, which does not exist (line 3)
-- 404
-  *  spec/html/proofer/fixtures/sorting/status/a_404.html: External link http://upload.wikimedia.org/wikipedia/en/thumb/not_here.png failed: 404 No error
-  *  spec/html/proofer/fixtures/sorting/status/broken_link.html: External link http://upload.wikimedia.org/wikipedia/en/thumb/fooooof.png failed: 404 No error
+- 301
+  *  spec/html/proofer/fixtures/sorting/status/a_404.html: External link http://upload.wikimedia.org/wikipedia/en/thumb/not_here.png failed: 301 No error
+  *  spec/html/proofer/fixtures/sorting/status/broken_link.html: External link http://upload.wikimedia.org/wikipedia/en/thumb/fooooof.png failed: 301 No error
     '''.strip)
       end
     end

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
-
 require 'bundler/setup'
 require_relative "../lib/html/proofer"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -302,6 +302,7 @@ files:
 - spec/html/proofer/fixtures/resources/books/assets/version-control-with-git.jpg
 - spec/html/proofer/fixtures/resources/books/nestedRelativeImages.html
 - spec/html/proofer/fixtures/resources/gpl.png
+- spec/html/proofer/fixtures/scripts/ignorableLinksViaOptions.html
 - spec/html/proofer/fixtures/scripts/script.js
 - spec/html/proofer/fixtures/scripts/script_broken_external.html
 - spec/html/proofer/fixtures/scripts/script_content.html
@@ -459,6 +460,7 @@ test_files:
 - spec/html/proofer/fixtures/resources/books/assets/version-control-with-git.jpg
 - spec/html/proofer/fixtures/resources/books/nestedRelativeImages.html
 - spec/html/proofer/fixtures/resources/gpl.png
+- spec/html/proofer/fixtures/scripts/ignorableLinksViaOptions.html
 - spec/html/proofer/fixtures/scripts/script.js
 - spec/html/proofer/fixtures/scripts/script_broken_external.html
 - spec/html/proofer/fixtures/scripts/script_content.html