html-proofer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5f9520152e65b775e134ac987d42fdeb69a4448
-  data.tar.gz: 6fb435127a7de49da70d5b9284d95bbb736bc19b
+  metadata.gz: 96ef995058e63021380229872126e11c18216d4a
+  data.tar.gz: 97f17a39a973e7819f52cbb0611f9f64f0152f94
 SHA512:
-  metadata.gz: d2e355f14b84c62685a44b01e93109f7d4c6ddad4884c952f4c734c8a473ee22f94a258b09601bac4a648d9d3fa61f0f949d800208296755e5d63be5a4ca6f67
-  data.tar.gz: 9e768b2b3920f5bf61fe1bcd257e890315cbe110c08afec49ba0a8e637341eef5c88f546adeeefcfa079a779b06b09f087ec18b00ed1c21f3f06ec038dd5c4c6
+  metadata.gz: 459bf3c2a753d660993f17ba982367a2ae395a04d3866bacb590f687c82b5929138fa596282d2ecac95f7644128777fceaa2fbeb2967737beb3d02cdd9d37c5d
+  data.tar.gz: 953d20ddcd61d8af3bec8eb7b9ffc2c8f532a16f9241960ee7040255b87079a4c8b72ba0210c411fbd4597833bf8f94d0d3f65c57870f88471d29bbf3c284838

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    html-proofer (0.2.3)
+    html-proofer (0.3.0)
       colored (~> 1.2)
       mercenary (~> 0.2.0)
       nokogiri (~> 1.6.0)
-      typhoeus (~> 0.6.3)
+      typhoeus (~> 0.6.7)
 
 GEM
   remote: http://rubygems.org/
@@ -20,7 +20,7 @@ GEM
     colored (1.2)
     diff-lcs (1.2.4)
     escape_utils (0.3.2)
-    ethon (0.6.1)
+    ethon (0.6.2)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
     ffi (1.9.3)
@@ -56,8 +56,8 @@ GEM
       nokogiri (>= 1.4.4)
     thread_safe (0.1.3)
       atomic
-    typhoeus (0.6.6)
-      ethon (~> 0.6.1)
+    typhoeus (0.6.7)
+      ethon (~> 0.6.2)
     tzinfo (0.3.38)
 
 PLATFORMS

data/README.md

@@ -69,7 +69,9 @@ Note: since `swap` is a bit special, you'll pass in a pair of `RegEx:String` val
 
 ## Usage with Jekyll
 
-Want to use HTML Proofer with your Jekyll site? Awesome. Simply add `gem 'html-proofer'` to your `Gemfile` as described above, and add the following to your `Rakefile`, using `rake test` to execute:
+Want to use HTML Proofer with your Jekyll site? Awesome. Simply add `gem 'html-proofer'`
+to your `Gemfile` as described above, and add the following to your `Rakefile`,
+using `rake test` to execute:
 
 ```ruby
 require 'html/proofer'
@@ -94,12 +96,23 @@ htmlproof ./_site
 * Whether your internal links are not broken; this includes hash references (`#linkToMe`)
 * Whether external links are working
 
-## Configuration 
+## Configuration
 
 The `HTML::Proofer` constructor takes an optional hash of additional options:
 
 * `:ext`: the extension (including the `.`) of your HTML files (default: `.html`)
 * `:href_swap`: a hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`.
-* `:href_ignore`: an array of Strings containing `href`s that are safe to ignore (default: `mailto`)
+* `:href_ignore`: an array of Strings containing `href`s that are safe to ignore (by default, `mailto` is always ignored)
+* `:disable_external`: if `true`, does not run the external link checker, which can take a lot of time (default: `false`)
 
-To any `<a>` or `<img>` tag, you may add the `data-proofer-ignore` attribute to ignore the link.
+You can also pass in any of Typhoeus' options for the external link check. For example:
+
+``` ruby
+HTML::Proofer.new("out/", {:ext => ".htm", :verbose = > true, :ssl_verifyhost => 2 })
+```
+
+This sets `HTML::Proofer`'s' extensions to use _.htm_, and gives Typhoeus a configurtion for it to be verbose, and use specific SSL settings. Check [the Typhoeus documentation](https://github.com/typhoeus/typhoeus#other-curl-options) for more information on what options it can receive.
+
+## Ignoring links
+
+To any `<a>` or `<img>` tag, you may add the `data-proofer-ignore` attribute to ignore the link.

data/html-proofer.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "mercenary",       "~> 0.2.0"
   gem.add_dependency "nokogiri",        "~> 1.6.0"
   gem.add_dependency "colored",         "~> 1.2"
-  gem.add_dependency "typhoeus",        "~> 0.6.3"
+  gem.add_dependency "typhoeus",        "~> 0.6.7"
 
   gem.add_development_dependency "html-pipeline", "~> 0.0.12"
   gem.add_development_dependency "rspec", "~> 2.13.0"

data/lib/html/proofer.rb

@@ -1,4 +1,5 @@
 require 'nokogiri'
+
 require File.dirname(__FILE__) + '/proofer/checkable'
 require File.dirname(__FILE__) + '/proofer/checks'
 
@@ -6,44 +7,109 @@ module HTML
   class Proofer
     def initialize(src, opts={})
       @srcDir = src
-      @options = {:ext => ".html"}.merge(opts)
+
+      @proofer_opts = {:ext => ".html", :href_swap => [], :href_ignore => [], :disable_external => false }
+      @options = @proofer_opts.merge({:followlocation => true}).merge(opts)
+
+      @failed_tests = []
     end
 
     def run
       total_files = 0
-      failed_tests = []
+      external_urls = {}
 
-      puts "Running #{get_checks} checks on #{@srcDir}... \n\n"
+      puts "Running #{get_checks} checks on #{@srcDir} on *#{@options[:ext]}... \n\n"
 
-      Dir.glob("#{@srcDir}/**/*#{@options[:ext]}") do |path|
+      files.each do |path|
         total_files += 1
         html = HTML::Proofer.create_nokogiri(path)
 
         get_checks.each do |klass|
           check = klass.new(@srcDir, path, html, @options)
           check.run
-          check.hydra.run
-          failed_tests.concat(check.issues) if check.issues.length > 0
+          external_urls.merge!(check.external_urls)
+          @failed_tests.concat(check.issues) if check.issues.length > 0
         end
       end
 
+      # the hypothesis is that Proofer runs way faster if we pull out
+      # all the external URLs and run the checks at the end. Otherwise, we're halting
+      # the consuming process for every file. In addition, sorting the list lets
+      # libcurl keep connections to hosts alive. Finally, we'll make a HEAD request,
+      # rather than GETing all the contents
+      external_urls = Hash[external_urls.sort]
+
+      unless @options[:disable_external]
+        puts "Checking #{external_urls.length} external links... \n\n"
+
+        # Typhoeus won't let you pass any non-Typhoeus option
+        @proofer_opts.each_key do |opt|
+          @options.delete opt
+        end
+
+        external_urls.each_pair do |href, filenames|
+          request = Typhoeus::Request.new(href, @options.merge({:method => :head}))
+          request.on_complete { |response| response_handler(response, filenames) }
+          hydra.queue request
+        end
+        hydra.run
+      end
+
       puts "Ran on #{total_files} files!"
 
-      if failed_tests.empty?
+      if @failed_tests.empty?
         puts "HTML-Proofer finished successfully.".green
-        exit 0
       else
-        failed_tests.each do |issue|
+        @failed_tests.each do |issue|
           $stderr.puts issue + "\n\n"
         end
 
-        raise "HTML-Proofer found #{failed_tests.length} failures!"
+        raise "HTML-Proofer found #{@failed_tests.length} failures!"
+      end
+    end
+
+    def response_handler(response, filenames)
+      href = response.options[:effective_url]
+      method = response.request.options[:method]
+      response_code = response.code
+
+      if response_code.between?(200, 299)
+        # continue with no op
+      elsif response.timed_out?
+         @failed_tests << "#{filenames.join(' ').blue}: External link #{href} failed: got a time out"
+      # hey here's a funny bug: sometimes HEAD requests return a 404, even on legitimate pages! The
+      # bug seems to affect curl; try `curl -I -X HEAD https://help.github.com/changing-author-info`
+      # so in these cases, try a regular `GET`. if it fails, it fails.
+      elsif response_code == 404 && method == :head
+        next_response = Typhoeus.get(href, @options)
+        response_handler(next_response, filenames)
+      elsif (response_code == 420 || response_code == 503) && method == :head
+        # 420s usually come from rate limiting; let's ignore the query and try just the path with a GET
+        uri = URI(href)
+        next_response = Typhoeus.get(uri.scheme + "://" + uri.host + uri.path, @options)
+        response_handler(next_response, filenames)
+      else
+        # Received a non-successful http response.
+        @failed_tests << "#{filenames.join(' ').blue}: External link #{href} failed: #{response_code} #{response.return_message}"
+      end
+    end
+
+    def hydra
+      @hydra ||= Typhoeus::Hydra.new
+    end
+
+    def files
+      if File.directory? @srcDir
+        Dir.glob("#{@srcDir}/**/*#{@options[:ext]}")
+      else
+        File.extname(@srcDir) == @options[:ext] ? [@srcDir] : []
       end
     end
 
     def self.create_nokogiri(path)
       path << "/index.html" if File.directory? path # support for Jekyll-style links
-      Nokogiri::HTML(File.read(path))
+      content = File.open(path, "rb") {|f| f.read }
+      Nokogiri::HTML(content)
     end
 
     def get_checks

data/lib/html/proofer/check.rb

@@ -10,7 +10,7 @@ class HTML::Proofer::Checks
 
   class Check
 
-    attr_reader :issues, :hydra, :src, :path, :options, :additional_href_ignores
+    attr_reader :issues, :src, :path, :options, :external_urls, :additional_href_ignores
 
     def initialize(src, path, html, opts={})
       @src    = src
@@ -18,10 +18,8 @@ class HTML::Proofer::Checks
       @html   = html
       @options = opts
       @issues = []
-      @checked_urls = {}
-
-      @hydra = Typhoeus::Hydra.hydra
-      @additional_href_ignores = @options[:href_ignore] || []
+      @additional_href_ignores = @options[:href_ignore]
+      @external_urls = {}
     end
 
     def run
@@ -36,44 +34,12 @@ class HTML::Proofer::Checks
       Dir[@site.config[:output_dir] + '/**/*'].select{ |f| File.file?(f) }
     end
 
-    def validate_url(href, issue_text)
-      return @checked_urls[href] if @checked_urls.has_key? href
-      request = Typhoeus::Request.new(href, {:followlocation => true})
-      request.on_complete do |response|
-        if response.success?
-          @checked_urls[href] = true
-        elsif response.timed_out?
-          self.add_issue(issue_text + " got a time out")
-        elsif response.code == 0
-          # Could not get an http response, something's wrong.
-          self.add_issue(issue_text + ". #{response.return_message}!")
-        else
-          response_code = response.code.to_s
-          if %w(420 503).include?(response_code)
-            # 420s usually come from rate limiting; let's ignore the query and try just the path
-            uri = URI(href)
-            response = Typhoeus.get(uri.scheme + "://" + uri.host + uri.path, {:followlocation => true})
-            self.add_issue("#{issue_text} Originally, this was a #{response_code}. Now, the HTTP request failed again: #{response.code.to_s}") unless response.success?
-          else
-            # Received a non-successful http response.
-            self.add_issue("#{issue_text} HTTP request failed: #{response_code}")
-          end
-        end
-
-        @checked_urls[href] = false unless response.success?
-      end
-      hydra.queue(request)
-    end
-
-    def request_url(url)
-      path = (url.path.nil? || url.path.empty? ? '/' : url.path)
-      req = Net::HTTP::Head.new(path)
-      http = Net::HTTP.new(url.host, url.port)
-      if url.instance_of? URI::HTTPS
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    def add_to_external_urls(href)
+      if @external_urls[href]
+        @external_urls[href] << @path
+      else
+        @external_urls[href] = [@path]
       end
-      res = http.request(req)
     end
 
     def self.subclasses

data/lib/html/proofer/checkable.rb

@@ -1,7 +1,6 @@
 module HTML
   class Proofer
     class Checkable
-
       def initialize(obj, check)
         @src = obj['src']
         @href = obj['href']
@@ -56,7 +55,7 @@ module HTML
 
       def ignore?
         uri = URI.parse url
-        @data_ignore_proofer || %w( mailto ).include?(uri.scheme) || @check.additional_href_ignores.include?(href)
+        @data_ignore_proofer || %w( mailto ).include?(uri.scheme) || @check.additional_href_ignores.include?(url)
       rescue URI::BadURIError
         false
       rescue URI::InvalidURIError
@@ -76,11 +75,13 @@ module HTML
       def file_path
         return if path.nil?
 
-        if path =~ /^\// #path relative to root
-          base = @check.src
-        elsif File.exist? File.expand_path path, @check.src #relative links, path is a file
+        if path =~ /^\// # path relative to root
+          base = File.directory?(@check.src) ? @check.src : File.dirname(@check.src)
+        elsif File.exist?(File.expand_path path, @check.src) # relative links, path is a file
+          base = File.dirname @check.path
+        elsif File.exist?(File.join(File.dirname(@check.path), path)) # relative links in nested dir, path is a file
           base = File.dirname @check.path
-        else #relative link, path is a directory
+        else # relative link, path is a directory
           base = @check.path
         end
 
@@ -102,7 +103,6 @@ module HTML
         path = file_path || @check.path
         File.expand_path path, Dir.pwd
       end
-
     end
   end
 end

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

@@ -24,24 +24,27 @@ end
 
 class Images < ::HTML::Proofer::Checks::Check
   def run
-    @html.css('img').each do |img|
+    @html.css('img').each do |i|
+      img = Image.new i, self
 
-      img = Image.new img, self
-
-      # screenshot filenames, return because invalid URL
+      # screenshot filenames should return because of terrible names
       return self.add_issue "image has a terrible filename (#{img.src})" if img.terrible_filename?
 
       # does the image exist?
       if img.missing_src?
         self.add_issue "image has no src attribute"
       elsif img.remote?
-        validate_url img.src, "external image #{img.src} does not exist"
+        return if img.ignore?
+        add_to_external_urls img.src
       else
+        return if img.ignore?
         self.add_issue("internal image #{img.src} does not exist") unless img.exists?
       end
 
       # check alt tag
       self.add_issue "image #{img.src} does not have an alt attribute" unless img.valid_alt_tag?
     end
+
+    return external_urls
   end
 end

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

@@ -15,9 +15,8 @@ end
 class Links < ::HTML::Proofer::Checks::Check
 
   def run
-    @html.css('a').each do |link|
-
-      link = Link.new link, self
+    @html.css('a').each do |l|
+      link = Link.new l, self
       return if link.ignore?
 
       # is there even a href?
@@ -28,7 +27,7 @@ class Links < ::HTML::Proofer::Checks::Check
 
       # does the file even exist?
       if link.remote?
-        validate_url link.href, "externally linking to #{link.href}, which does not exist"
+        add_to_external_urls link.href
       else
         self.add_issue "internally linking to #{link.href}, which does not exist" unless link.exists?
       end
@@ -36,7 +35,7 @@ class Links < ::HTML::Proofer::Checks::Check
       # verify the target hash
       if link.hash
         if link.remote?
-          #not yet checked
+          add_to_external_urls link.href
         elsif link.internal?
           self.add_issue "linking to internal hash ##{link.hash} that does not exist" unless hash_check @html, link.hash
         elsif link.external?
@@ -49,6 +48,8 @@ class Links < ::HTML::Proofer::Checks::Check
         end
       end
     end
+
+    return external_urls
   end
 
   def hash_check(html, href_hash)

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/html/proofer/fixtures/folder/relativeImage.html

@@ -0,0 +1,2 @@
+
+<ing alt="sure thing" src="assets/barrel.png">Folder relative to self</a>

data/spec/html/proofer/fixtures/linkWithRedirect.html

@@ -2,8 +2,9 @@
 
 <body>
 
-	<p>Blah blah blah. <a href="http://www.capify.org/">This is a redirect.</a>. </p>
+	<p>Blah blah blah. <a href="http://github.github.com/github-flavored-markdown/">This is a redirect.</a>. </p>
 
+	<p>Blah blah blah. <a href="https://help.github.com/changing-author-info/">This is another redirect.</a>. </p>
 </body>
 
-</html>
+</html>

data/spec/html/proofer/fixtures/relativeLinks.html

@@ -2,3 +2,5 @@
 <a href="index.html">Relative to self</a>
 <a href="folder/">Folder relative to self</a>
 <a href="index.html#anchor">Anchor relative to self</a>
+
+<img alt="sure thing" src="gpl.png"/>Relative to self

data/spec/html/proofer/fixtures/resources/books/nestedRelativeImages.html

@@ -0,0 +1,5 @@
+<img src="assets/pro-git.jpg" alt="Pro Git">
+
+<img src="assets/getting-good-with-git.jpg" alt="Getting Good with Git">
+
+<img src="assets/version-control-with-git.jpg" alt="Version Control with Git, 2nd Edition">

data/spec/html/proofer/fixtures/rootRelativeImages.html

@@ -0,0 +1,2 @@
+
+<img alt="sure thing" src="/gpl.png"/>Relative to root

data/spec/html/proofer/images_spec.rb

@@ -3,59 +3,59 @@ require "spec_helper"
 describe "Image tests" do
   it "passes for existing external images" do
     externalImageFilepath = "#{FIXTURES_DIR}/existingImageExternal.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
-    @imageCheck.run
-    @imageCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(externalImageFilepath).run }
+    output.should == ""
   end
 
   it "fails for image without alt attribute" do
     missingAltFilepath = "#{FIXTURES_DIR}/missingImageAlt.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", missingAltFilepath, HTML::Proofer.create_nokogiri(missingAltFilepath))
-    @imageCheck.run
-    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageAlt.html".blue + ": image ./gpl.png does not have an alt attribute")
+    output = capture_stderr { HTML::Proofer.new(missingAltFilepath).run }
+    output.should match /gpl.png does not have an alt attribute/
   end
 
   it "fails for image with an empty alt attribute" do
     missingAltFilepath = "#{FIXTURES_DIR}/missingImageAltText.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", missingAltFilepath, HTML::Proofer.create_nokogiri(missingAltFilepath))
-    @imageCheck.run
-    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageAltText.html".blue + ": image ./gpl.png does not have an alt attribute")
+    output = capture_stderr { HTML::Proofer.new(missingAltFilepath).run }
+    output.should match /gpl.png does not have an alt attribute/
   end
 
   it "fails for missing external images" do
     externalImageFilepath = "#{FIXTURES_DIR}/missingImageExternal.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
-    @imageCheck.run
-    @imageCheck.hydra.run
-    @imageCheck.issues[0].sub!(/ #<Typhoeus::Response:[\w]+>/, "")
-    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageExternal.html".blue + ": external image http://www.whatthehell does not exist. Couldn't resolve host name!")
+    output = capture_stderr { HTML::Proofer.new(externalImageFilepath).run }
+    output.should match /External link http:\/\/www.whatthehell\/? failed: 0 Couldn't resolve host/
   end
 
   it "fails for missing internal images" do
     internalImageFilepath = "#{FIXTURES_DIR}/missingImageInternal.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", internalImageFilepath, HTML::Proofer.create_nokogiri(internalImageFilepath))
-    @imageCheck.run
-    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageInternal.html".blue + ": internal image ./doesnotexist.png does not exist")
+    output = capture_stderr { HTML::Proofer.new(internalImageFilepath).run }
+    output.should match /doesnotexist.png does not exist/
   end
 
   it "fails for image with no src" do
     imageSrcFilepath = "#{FIXTURES_DIR}/missingImageSrc.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", imageSrcFilepath, HTML::Proofer.create_nokogiri(imageSrcFilepath))
-    @imageCheck.run
-    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageSrc.html".blue + ": image has no src attribute")
+    output = capture_stderr { HTML::Proofer.new(imageSrcFilepath).run }
+    output.should match /image has no src attribute/
   end
 
   it "fails for image with default mac filename" do
     terribleImageName = "#{FIXTURES_DIR}/terribleImageName.html"
-    @imageCheck = Images.new("#{FIXTURES_DIR}", terribleImageName, HTML::Proofer.create_nokogiri(terribleImageName))
-    @imageCheck.run
-    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/terribleImageName.html".blue + ": image has a terrible filename (./Screen Shot 2012-08-09 at 7.51.18 AM.png)")
+    output = capture_stderr { HTML::Proofer.new(terribleImageName).run }
+    output.should match /image has a terrible filename/
   end
 
   it 'ignores images marked as ignore data-proofer-ignore' do
     ignorableImages = "#{FIXTURES_DIR}/ignorableImages.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", ignorableImages, HTML::Proofer.create_nokogiri(ignorableImages))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(ignorableImages).run }
+    output.should == ""
+  end
+
+  it 'properly checks relative images' do
+    relativeImages = "#{FIXTURES_DIR}/rootRelativeImages.html"
+    output = capture_stderr { HTML::Proofer.new(relativeImages).run }
+    output.should == ""
+
+    relativeImages = "#{FIXTURES_DIR}/resources/books/nestedRelativeImages.html"
+    output = capture_stderr { HTML::Proofer.new(relativeImages).run }
+    output.should == ""
   end
 end

data/spec/html/proofer/links_spec.rb

@@ -4,94 +4,79 @@ describe "Links tests" do
 
   it "fails for broken external hash (even if the file exists)" do
     brokenHashExternalFilepath = "#{FIXTURES_DIR}/brokenHashExternal.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", brokenHashExternalFilepath, HTML::Proofer.create_nokogiri(brokenHashExternalFilepath))
-    @linkCheck.run
-    @linkCheck.issues[1].should eq("spec/html/proofer/fixtures/brokenHashExternal.html".blue + ": linking to ./missingImageAlt.html#asdfasfdkafl, but asdfasfdkafl does not exist")
+    output = capture_stderr { HTML::Proofer.new(brokenHashExternalFilepath).run }
+    output.should match /linking to .\/missingImageAlt.html#asdfasfdkafl, but asdfasfdkafl does not exist/
   end
 
   it "fails for broken internal hash" do
     brokenHashInternalFilepath = "#{FIXTURES_DIR}/brokenHashInternal.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", brokenHashInternalFilepath, HTML::Proofer.create_nokogiri(brokenHashInternalFilepath))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenHashInternal.html".blue + ": linking to internal hash #noHash that does not exist")
+    output = capture_stderr { HTML::Proofer.new(brokenHashInternalFilepath).run }
+    output.should match /linking to internal hash #noHash that does not exist/
   end
 
   it "fails for broken external links" do
     brokenLinkExternalFilepath = "#{FIXTURES_DIR}/brokenLinkExternal.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", brokenLinkExternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkExternalFilepath))
-    @linkCheck.run
-    @linkCheck.hydra.run
-    @linkCheck.issues[0].sub!(/ #<Typhoeus::Response:[\w]+>/, "")
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkExternal.html".blue + ": externally linking to http://www.asdo3IRJ395295jsingrkrg4.com, which does not exist. Couldn't resolve host name!")
+    output = capture_stderr { HTML::Proofer.new(brokenLinkExternalFilepath).run }
+    output.should match /External link http:\/\/www.asdo3IRJ395295jsingrkrg4.com\/? failed: 0 Couldn't resolve host name/
   end
 
   it "fails for broken internal links" do
     brokenLinkInternalFilepath = "#{FIXTURES_DIR}/brokenLinkInternal.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", brokenLinkInternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkInternalFilepath))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkInternal.html".blue + ": internally linking to ./notreal.html, which does not exist")
+    output = capture_stderr { HTML::Proofer.new(brokenLinkInternalFilepath).run }
+    output.should match /internally linking to .\/notreal.html, which does not exist/
   end
 
   it "fails for link with no href" do
     missingLinkHrefFilepath = "#{FIXTURES_DIR}/missingLinkHref.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", missingLinkHrefFilepath, HTML::Proofer.create_nokogiri(missingLinkHrefFilepath))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/missingLinkHref.html".blue + ": link has no href attribute")
+    output = capture_stderr { HTML::Proofer.new(missingLinkHrefFilepath).run }
+    output.should match /link has no href attribute/
   end
 
   it "should follow redirects" do
     linkWithRedirectFilepath = "#{FIXTURES_DIR}/linkWithRedirect.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", linkWithRedirectFilepath, HTML::Proofer.create_nokogiri(linkWithRedirectFilepath))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(linkWithRedirectFilepath).run }
+    output.should == ""
   end
 
   it "should understand https" do
     linkWithHttpsFilepath = "#{FIXTURES_DIR}/linkWithHttps.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", linkWithHttpsFilepath, HTML::Proofer.create_nokogiri(linkWithHttpsFilepath))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(linkWithHttpsFilepath).run }
+    output.should == ""
   end
 
   it "fails for broken hash links with status code numbers" do
     brokenLinkWithNumberFilepath = "#{FIXTURES_DIR}/brokenLinkWithNumber.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", brokenLinkWithNumberFilepath, HTML::Proofer.create_nokogiri(brokenLinkWithNumberFilepath))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq("\e[34mspec/html/proofer/fixtures/brokenLinkWithNumber.html\e[0m: linking to internal hash #25-method-not-allowed that does not exist")
+    output = capture_stderr { HTML::Proofer.new(brokenLinkWithNumberFilepath).run }
+    output.should match /linking to internal hash #25-method-not-allowed that does not exist/
   end
 
   it 'properly resolves implicit /index.html in link paths' do
     linkToFolder = "#{FIXTURES_DIR}/linkToFolder.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", linkToFolder, HTML::Proofer.create_nokogiri(linkToFolder))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(linkToFolder).run }
+    output.should == ""
   end
 
   it 'properly checks links to root' do
     rootLink = "#{FIXTURES_DIR}/rootLink.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", rootLink, HTML::Proofer.create_nokogiri(rootLink))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(rootLink).run }
+    output.should == ""
   end
 
   it 'properly checks relative links' do
     relativeLinks = "#{FIXTURES_DIR}/relativeLinks.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", relativeLinks, HTML::Proofer.create_nokogiri(relativeLinks))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(relativeLinks).run }
+    output.should == ""
   end
 
   it 'ignores links marked as ignore data-proofer-ignore' do
     ignorableLinks = "#{FIXTURES_DIR}/ignorableLinks.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", ignorableLinks, HTML::Proofer.create_nokogiri(ignorableLinks))
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(ignorableLinks).run }
+    output.should == ""
   end
 
   it 'translates links via href_swap' do
     translatedLink = "#{FIXTURES_DIR}/linkTranslatedViaHrefSwap.html"
-    @linkCheck = Links.new("#{FIXTURES_DIR}", translatedLink, HTML::Proofer.create_nokogiri(translatedLink), {:href_swap => { /\A\/articles\/([\w-]+)/ => "\\1.html" }})
-    @linkCheck.run
-    @linkCheck.issues[0].should eq(nil)
+    output = capture_stderr { HTML::Proofer.new(translatedLink, {:href_swap => { /\A\/articles\/([\w-]+)/ => "\\1.html" }}).run }
+    output.should == ""
   end
 end

data/spec/spec_helper.rb

@@ -14,4 +14,19 @@ RSpec.configure do |config|
 
   # Use the specified formatter
   config.formatter = :documentation # :progress, :html, :textmate
-end
+end
+
+def capture_stderr(&block)
+  original_stderr = $stderr
+  original_stdout = $stdout
+  $stderr = fake_err = StringIO.new
+  $stdout = fake_out = StringIO.new
+  begin
+    yield
+  rescue RuntimeError
+  ensure
+    $stderr = original_stderr
+    # $stdout = original_stdout
+  end
+  fake_err.string
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.6.7
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,9 @@ files:
 - spec/html/proofer/fixtures/brokenLinkWithNumber.html
 - spec/html/proofer/fixtures/existingImageExternal.html
 - spec/html/proofer/fixtures/folder/anchorLink.html
+- spec/html/proofer/fixtures/folder/assets/barrel.png
 - spec/html/proofer/fixtures/folder/index.html
+- spec/html/proofer/fixtures/folder/relativeImage.html
 - spec/html/proofer/fixtures/gpl.png
 - spec/html/proofer/fixtures/ignorableImages.html
 - spec/html/proofer/fixtures/ignorableLinks.html
@@ -157,7 +159,12 @@ files:
 - spec/html/proofer/fixtures/missingLinkHref.html
 - spec/html/proofer/fixtures/notarealhash.html
 - spec/html/proofer/fixtures/relativeLinks.html
+- spec/html/proofer/fixtures/resources/books/assets/getting-good-with-git.jpg
+- spec/html/proofer/fixtures/resources/books/assets/pro-git.jpg
+- spec/html/proofer/fixtures/resources/books/assets/version-control-with-git.jpg
+- spec/html/proofer/fixtures/resources/books/nestedRelativeImages.html
 - spec/html/proofer/fixtures/rootLink.html
+- spec/html/proofer/fixtures/rootRelativeImages.html
 - spec/html/proofer/fixtures/terribleImageName.html
 - spec/html/proofer/images_spec.rb
 - spec/html/proofer/links_spec.rb
@@ -199,7 +206,9 @@ test_files:
 - spec/html/proofer/fixtures/brokenLinkWithNumber.html
 - spec/html/proofer/fixtures/existingImageExternal.html
 - spec/html/proofer/fixtures/folder/anchorLink.html
+- spec/html/proofer/fixtures/folder/assets/barrel.png
 - spec/html/proofer/fixtures/folder/index.html
+- spec/html/proofer/fixtures/folder/relativeImage.html
 - spec/html/proofer/fixtures/gpl.png
 - spec/html/proofer/fixtures/ignorableImages.html
 - spec/html/proofer/fixtures/ignorableLinks.html
@@ -216,7 +225,12 @@ test_files:
 - spec/html/proofer/fixtures/missingLinkHref.html
 - spec/html/proofer/fixtures/notarealhash.html
 - spec/html/proofer/fixtures/relativeLinks.html
+- spec/html/proofer/fixtures/resources/books/assets/getting-good-with-git.jpg
+- spec/html/proofer/fixtures/resources/books/assets/pro-git.jpg
+- spec/html/proofer/fixtures/resources/books/assets/version-control-with-git.jpg
+- spec/html/proofer/fixtures/resources/books/nestedRelativeImages.html
 - spec/html/proofer/fixtures/rootLink.html
+- spec/html/proofer/fixtures/rootRelativeImages.html
 - spec/html/proofer/fixtures/terribleImageName.html
 - spec/html/proofer/images_spec.rb
 - spec/html/proofer/links_spec.rb