html-proofer 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d35ff970865a64a0f6a4c564134ac30a060dfc3
-  data.tar.gz: 34525a50cdf84967b1549158746de39544bc08ba
+  metadata.gz: 65597a503b7fc561c9dae5377f36dd3860581a92
+  data.tar.gz: 44f24659044b6122d43476be9f41c3be1f8633b1
 SHA512:
-  metadata.gz: de0f69c219747e9daae75bb9ce7db7118e7b02989d9bb365aa2e9e88db339229a80012e1a5119c8e08fcb4de31bfd1ca39cd978599744dbeb41219cce8389cec
-  data.tar.gz: bcd0193c557dee8c3906b869c5e64c536b45aa8fde4de65e4a154ec4822bef3ff4b7d022dd2923dc5200713e75277d763e8615043c37c56dc6480dc97d109b9b
+  metadata.gz: 06b4ec0986dc6cd27575d65f73a29d00c2166b0e4b8c15e4b15d345a90ea382f4b6710d8cc67ff476debee80867e0489181bf65bb9f22e4b2ae2eb6eff958425
+  data.tar.gz: a14622a437b34deee71d3a6c0daf42f466d35a980531993d505a5c72c736c7a640da2ff9992d46063b5674334bf28e3d5422a9ce1e800b1533d863be05b99e97

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-before_install:
-  - export NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  - 1.9
+  - 2.0
+  - 2.1
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

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.png?branch=master)](https://travis-ci.org/gjtorikian/html-proofer) [![Gem Version](https://badge.fury.io/rb/html-proofer.png)](http://badge.fury.io/rb/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
 
@@ -58,7 +58,7 @@ HTML::Proofer.new("./out").run
 
 ### Using on the command-line
 
-You'll get a new program called `htmlproof` with this gem. Jawesome!
+You'll get a new program called `htmlproof` with this gem. Terrific!
 
 Use it like you'd expect to:
 
@@ -90,6 +90,14 @@ Don't have or want a `Rakefile`? You _could_ also do something like the followin
 htmlproof ./_site
 ```
 
+### Real-life examples
+
+Project | Repository
+:--- | :---
+[Raspberry Pi documentation](http://www.raspberrypi.org/documentation/) | [raspberrypi/documentation]( https://github.com/raspberrypi/documentation)
+[Open Whisper Systems website](https://whispersystems.org/) | [WhisperSystems/whispersystems.org](https://github.com/WhisperSystems/whispersystems.org)
+[Jekyll website](http://jekyllrb.com/) | [jekyll/jekyll](https://github.com/jekyll/jekyll)
+
 ## What's Tested?
 
 ### Images
@@ -124,20 +132,33 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `ext` | The extension of your HTML files including the dot. | `.html`
 | `favicon` | Enables the favicon checker. | `false` |
 | `followlocation` | Follows external redirections. Amends missing trailing slashes to internal directories. | `true` |
-| `as_link_array` | Assumes that you've passed in just an array of links to check. | `false` |
+| `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |
 | `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Certain URIs, like `mailto` and `tel`, are always ignored. | `[]` |
 | `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
 | `href_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. | `{}` |
 | `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` |
+| `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
 
 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 })
+HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost => 2 })
 ```
 
 This sets `HTML::Proofer`'s extensions to use _.htm_, and gives Typhoeus a configuration 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.
 
+Instead of a directory as the first argument, you can also pass in an array of links:
+
+``` ruby
+HTML::Proofer.new(["http://github.com", "http://jekyllrb.com"])
+```
+
+This configures Proofer to just test those links to ensure they are valid. Note that for the command-line, you'll need to pass a special `--as-links` argument:
+
+``` bash
+bin/htmlproof www.google.com,www.github.com --as-links
+```
+
 ## Ignoring content
 
 Add the `data-proofer-ignore` attribute to any tag to ignore it from the checks.

data/Rakefile

@@ -5,4 +5,19 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => [:spec, :proof_readme]
+
+task :proof_readme do
+  require 'html/proofer'
+  require 'redcarpet'
+
+  redcarpet = Redcarpet::Markdown.new Redcarpet::Render::HTML.new({}), {}
+  html = redcarpet.render File.open("README.md").read
+
+  mkdir_p "out"
+  File.open "out/README.html", File::CREAT|File::WRONLY do |file|
+    file.puts html
+  end
+
+  HTML::Proofer.new("./out").run
+end

data/bin/htmlproof

@@ -16,12 +16,14 @@ Mercenary.program(:htmlproof) do |p|
 
   p.option 'ext', '--ext EXT', 'The extension of your HTML files (default: `.html`)'
   p.option 'favicon', '--favicon', 'Enables the favicon checker (default: `false`).'
-  p.option 'as-links', '--as-links', 'Assumes that `PATH` is an array of links to check.'
+  p.option 'as-links', '--as-links', 'Assumes that `PATH` is a comma-separated array of links to check.'
   p.option 'swap', '--swap regex:string,[regex:string,...]', Array, 'Array containing key-value pairs of `RegExp:String`. It transforms links that match `RegExp` into `String`'
   p.option 'href_ignore', '--href_ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore. Certain URIs, like `mailto` and `tel`, are always ignored.'
   p.option 'alt_ignore', '--alt_ignore image1,[image2,...]', Array, 'Array of Strings containing `img`s whose missing `alt` tags are safe to ignore'
   p.option 'disable_external', '--disable_external', 'Disables the external link checker (default: `false`)'
+  p.option 'only-4xx', '--only-4xx', 'Only reports errors for links that fall within the 4x status code range.'
   p.option 'verbose', '--verbose', 'Enables more verbose logging.'
+  p.option 'directory_index_file', '--directory_index_file', 'Sets the file to look for when a link refers to a directory.'
 
   p.action do |args, opts|
     args = ["."] if args.empty?
@@ -36,14 +38,15 @@ Mercenary.program(:htmlproof) do |p|
         options[:href_swap][%r{#{pair[0]}}] = pair[1]
       end
     end
-    options[:as_link_array] = opts["as-links"] unless opts["as-links"].nil?
+
     options[:href_ignore] = opts["href_ignore"] unless opts["href_ignore"].nil?
     options[:alt_ignore] = opts["alt_ignore"] unless opts["alt_ignore"].nil?
     options[:disable_external] = opts["disable_external"] unless opts["disable_external"].nil?
     options[:favicon] = opts["favicon"] unless opts["favicon"].nil?
     options[:verbose] = opts["verbose"] unless opts["verbose"].nil?
+    options[:directory_index_file] = opts["directory_index_file"] unless opts["directory_index_file"].nil?
 
-    path = path.delete(' ').split(",") if options[:as_link_array]
+    path = path.delete(' ').split(",") if opts["as-links"]
 
     HTML::Proofer.new(path, options).run
   end

data/html-proofer.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "html-proofer"
-  gem.version       = "1.2.1"
+  gem.version       = "1.3.0"
   gem.authors       = ["Garen Torikian"]
   gem.email         = ["gjtorikian@gmail.com"]
   gem.description   = %q{Test your rendered HTML files to make sure they're accurate.}
@@ -21,8 +21,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "typhoeus",        "~> 0.6.7"
   gem.add_dependency "yell",            "~> 2.0"
 
-  gem.add_development_dependency "html-pipeline", "~> 1.8"
-  gem.add_development_dependency "escape_utils", "~> 1.0" # Ruby 2.1 fix
+  gem.add_development_dependency "redcarpet"
   gem.add_development_dependency "rspec", "~> 2.13.0"
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "awesome_print"
 end

data/lib/html/proofer.rb

@@ -1,15 +1,29 @@
 require 'nokogiri'
 require 'yell'
 
-require File.dirname(__FILE__) + '/proofer/checkable'
-require File.dirname(__FILE__) + '/proofer/checks'
+begin
+  require "awesome_print"
+rescue LoadError; end
+
+[
+  'checkable',
+  'checks',
+  'issue'
+].each { |r| require File.join(File.dirname(__FILE__), "proofer", r) }
 
 module HTML
+
+  def self.colorize(color, string)
+    if $stdout.isatty && $stderr.isatty
+      Colored.colorize(string, :foreground => color)
+    else
+      string
+    end
+  end
+
   class Proofer
     include Yell::Loggable
 
-    attr_accessor :failed_tests
-
     def initialize(src, opts={})
       @src = src
 
@@ -21,9 +35,23 @@ module HTML
         :alt_ignore => [],
         :disable_external => false,
         :verbose => false,
-        :as_link_array => false
+        :only_4xx => false,
+        :directory_index_file => "index.html"
+      }
+
+      @typhoeus_opts = {
+        :followlocation => true
       }
-      @options = @proofer_opts.merge({:followlocation => true}).merge(opts)
+
+      # Typhoeus won't let you pass any non-Typhoeus option
+      opts.keys.each do |key|
+        unless @typhoeus_opts[key].nil?
+          @typhoeus_opts[key] = opts[key]
+          @proofer_opts[key] = opts[key]
+        end
+      end
+
+      @options = @proofer_opts.merge(@typhoeus_opts).merge(opts)
 
       @failed_tests = []
 
@@ -34,18 +62,18 @@ module HTML
     end
 
     def run
-      unless @options[:as_link_array]
+      unless @src.is_a? Array
         total_files = 0
         external_urls = {}
 
-        logger.info colorize :white, "Running #{get_checks} checks on #{@src} on *#{@options[:ext]}... \n\n"
+        logger.info HTML::colorize :white, "Running #{get_checks} checks on #{@src} on *#{@options[:ext]}... \n\n"
 
         files.each do |path|
           total_files += 1
           html = HTML::Proofer.create_nokogiri(path)
 
           get_checks.each do |klass|
-            logger.debug colorize :blue, "Checking #{klass.to_s.downcase} on #{path} ..."
+            logger.debug HTML::colorize :blue, "Checking #{klass.to_s.downcase} on #{path} ..."
             check =  Object.const_get(klass).new(@src, path, html, @options)
             check.run
             external_urls.merge!(check.external_urls)
@@ -55,20 +83,20 @@ module HTML
 
         external_link_checker(external_urls) unless @options[:disable_external]
 
-        logger.info colorize :green, "Ran on #{total_files} files!\n\n"
+        logger.info HTML::colorize :green, "Ran on #{total_files} files!\n\n"
       else
         external_urls = Hash[*@src.map{ |s| [s, nil] }.flatten]
         external_link_checker(external_urls) unless @options[:disable_external]
       end
 
       if @failed_tests.empty?
-        logger.info colorize :green, "HTML-Proofer finished successfully."
+        logger.info HTML::colorize :green, "HTML-Proofer finished successfully."
       else
-        @failed_tests.sort.each do |issue|
-          logger.error colorize :red, issue.to_s
+        @failed_tests.sort_by(&:path).each do |issue|
+          logger.error HTML::colorize :red, issue.to_s
         end
 
-        raise colorize :red, "HTML-Proofer found #{@failed_tests.length} failures!"
+        raise HTML::colorize :red, "HTML-Proofer found #{@failed_tests.length} failures!"
       end
     end
 
@@ -80,24 +108,19 @@ module HTML
     def external_link_checker(external_urls)
       external_urls = Hash[external_urls.sort]
 
-      logger.info colorize :yellow, "Checking #{external_urls.length} external links..."
-
-      # Typhoeus won't let you pass any non-Typhoeus option
-      @proofer_opts.each_key do |opt|
-        @options.delete opt
-      end
+      logger.info HTML::colorize :yellow, "Checking #{external_urls.length} external links..."
 
       Ethon.logger = logger # log from Typhoeus/Ethon
 
       external_urls.each_pair do |href, filenames|
         queue_request(:head, href, filenames)
       end
-      logger.debug colorize :yellow, "Running requests for all #{hydra.queued_requests.size} external URLs..."
+      logger.debug HTML::colorize :yellow, "Running requests for all #{hydra.queued_requests.size} external URLs..."
       hydra.run
     end
 
     def queue_request(method, href, filenames)
-      request = Typhoeus::Request.new(href, @options.merge({:method => method}))
+      request = Typhoeus::Request.new(href, @typhoeus_opts.merge({:method => method}))
       request.on_complete { |response| response_handler(response, filenames) }
       hydra.queue request
     end
@@ -114,9 +137,8 @@ module HTML
       if response_code.between?(200, 299)
         # continue with no op
       elsif response.timed_out?
-        failed_test_msg = "External link #{href} failed: got a time out"
-        failed_test_msg.insert(0, "#{filenames.join(' ').blue}: ") unless filenames.nil?
-        @failed_tests << failed_test_msg
+        return if @options[:only_4xx]
+        add_failed_tests filenames, "External link #{href} failed: got a time out", response_code
       elsif (response_code == 405 || 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)
@@ -126,10 +148,9 @@ module HTML
       elsif method == :head
         queue_request(:get, href, filenames)
       else
+        return if @options[:only_4xx] && !response_code.between?(400, 499)
         # Received a non-successful http response.
-        failed_test_msg = "External link #{href} failed: #{response_code} #{response.return_message}"
-        failed_test_msg.insert(0, "#{filenames.join(' ').blue}: ") unless filenames.nil?
-        @failed_tests << failed_test_msg
+        add_failed_tests filenames, "External link #{href} failed: #{response_code} #{response.return_message}", response_code
       end
     end
 
@@ -139,15 +160,16 @@ module HTML
 
     def files
       if File.directory? @src
-        Dir.glob("#{@src}/**/*#{@options[:ext]}")
+        Dir.glob File.join(@src, "**", "*#{@options[:ext]}")
+      elsif File.extname(@src) == @options[:ext]
+        [@src]
       else
-        File.extname(@src) == @options[:ext] ? [@src] : []
+        []
       end
     end
 
     def self.create_nokogiri(path)
-      path << "/index.html" if File.directory? path # support for Jekyll-style links
-      content = File.open(path, "rb") {|f| f.read }
+      content = File.open(path).read
       Nokogiri::HTML(content)
     end
 
@@ -161,12 +183,21 @@ module HTML
       @options[:verbose] ? :debug : :info
     end
 
-    def colorize(color, string)
-      if $stdout.isatty && $stderr.isatty
-        Colored.colorize(string, :foreground => color)
-      else
-        string
+    def add_failed_tests(filenames, desc, status = nil)
+      if filenames.nil?
+        @failed_tests << Checks::Issue.new("", desc, status)
+      elsif
+        filenames.each { |f|
+          @failed_tests << Checks::Issue.new(f, desc, status)
+        }
       end
     end
+
+    def failed_tests
+      return [] if @failed_tests.empty?
+      result = []
+      @failed_tests.each { |f| result << f.to_s }
+      result
+    end
   end
 end

data/lib/html/proofer/check.rb

@@ -3,7 +3,6 @@ require 'net/http'
 require 'net/https'
 require 'timeout'
 require 'uri'
-require 'colored'
 require 'typhoeus'
 
 class HTML::Proofer::Checks
@@ -27,8 +26,8 @@ class HTML::Proofer::Checks
       raise NotImplementedError.new("HTML::Proofer::Check subclasses must implement #run")
     end
 
-    def add_issue(desc)
-      @issues << "#{@path.blue}: #{desc}"
+    def add_issue(desc, status = nil)
+      @issues << Issue.new(@path, desc, status)
     end
 
     def output_filenames

data/lib/html/proofer/checkable.rb

@@ -32,33 +32,30 @@ module HTML
       end
 
       def valid?
-        begin
-          URI.parse url
-        rescue
-          false
-        end
+        !parts.nil?
       end
 
       def parts
-         URI.parse url
+        URI::Parser.new(:ESCAPED => '\%|\|').parse url
+      rescue URI::Error
+        nil
       end
 
       def path
-        parts.path
+        parts.path if !parts.nil?
       end
 
       def hash
-        parts.fragment
+        parts.fragment if !parts.nil?
+      end
+
+      def scheme
+        parts.scheme if !parts.nil?
       end
 
       # path is to an external server
       def remote?
-        uri = URI.parse url
-        %w( http https ).include?(uri.scheme)
-      rescue URI::BadURIError
-        false
-      rescue URI::InvalidURIError
-        false
+        %w( http https ).include? scheme
       end
 
       def ignore?
@@ -74,12 +71,7 @@ module HTML
           return true if ignores_pattern_check(@check.additional_alt_ignores)
         end
 
-        uri = URI.parse url
-        %w( mailto tel ).include?(uri.scheme)
-      rescue URI::BadURIError
-        false
-      rescue URI::InvalidURIError
-        false
+        %w( mailto tel ).include? scheme
       end
 
       # path is external to the file
@@ -87,9 +79,9 @@ module HTML
         !internal?
       end
 
-      # path is an anchor
+      # path is an anchor or a query
       def internal?
-        url[0] == "#"
+        url.start_with? "#", "?"
       end
 
       def file_path
@@ -107,8 +99,10 @@ module HTML
 
         file = File.join base, path
 
-        # implicit /index.html support, with support for trailing slashes
-        file = File.join path, "index.html" if File.directory? File.expand_path file, @check.src
+        # implicit index support
+        if File.directory? file and !unslashed_directory? file
+          file = File.join file, @check.options[:directory_index_file]
+        end
 
         file
       end
@@ -135,6 +129,10 @@ module HTML
 
         false
       end
+
+      def unslashed_directory? file
+        File.directory? file and !file.end_with? File::SEPARATOR and !@check.options[:followlocation]
+      end
     end
   end
 end

data/lib/html/proofer/checks.rb

@@ -2,12 +2,13 @@ module HTML
   class Proofer
     class Checks
       [
-        "/check",
-        "/checks/images",
-        "/checks/links",
-        "/checks/scripts",
-        "/checks/favicon"
-      ].each { |r| require File.dirname(__FILE__) + r }
+        "issue",
+        "check",
+        "checks/images",
+        "checks/links",
+        "checks/scripts",
+        "checks/favicon"
+      ].each { |r| require File.join(File.dirname(__FILE__), r) }
     end
   end
 end

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

@@ -11,8 +11,9 @@ class Favicons < ::HTML::Proofer::Checks::Check
   def run
     return unless @options[:favicon]
 
-    @html.css("link").each do |favicon|
+    @html.xpath("//link[not(ancestor::pre or ancestor::code)]").each do |favicon|
       favicon = Favicon.new favicon, "favicon", self
+      next if favicon.ignore?
       return if favicon.rel.split(" ").last.eql? "icon"
     end
 

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

@@ -10,10 +10,6 @@ class Link < ::HTML::Proofer::Checkable
     href.nil? and @name.nil? and @id.nil?
   end
 
-  def unslashed_directory?
-    File.directory? absolute_path and !absolute_path.end_with? File::SEPARATOR
-  end
-
 end
 
 class Links < ::HTML::Proofer::Checks::Check
@@ -45,7 +41,7 @@ class Links < ::HTML::Proofer::Checks::Check
       end
 
       # has the local directory a trailing slash?
-      if !@options[:followlocation] and !link.remote? and link.unslashed_directory?
+      if link.unslashed_directory? link.absolute_path
         self.add_issue("internally linking to a directory #{link.absolute_path} without trailing slash")
         next
       end

data/lib/html/proofer/issue.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'colored'
+
+class HTML::Proofer::Checks
+
+  class Issue
+
+    attr_reader :path, :desc, :status
+
+    def initialize(path, desc, status = nil)
+      @path = path
+      @desc = desc
+      @status = status
+    end
+
+    def to_s
+      "#{HTML::colorize(:blue, @path)}: #{desc}"
+    end
+
+  end
+end

data/spec/html/proofer/favicon_spec.rb

@@ -37,10 +37,10 @@ describe "Favicons test" do
     output.should == ""
   end
 
-  it "passes for broken favicon with data-proofer-ignore" do
+  it "fails for broken favicon with data-proofer-ignore" do
     broken_but_ignored = "#{FIXTURES_DIR}/favicon/favicon_broken_but_ignored.html"
     output = capture_stderr { HTML::Proofer.new(broken_but_ignored, {:favicon => true}).run }
-    output.should == ""
+    output.should match /no favicon specified/
   end
 
 end

data/spec/html/proofer/fixtures/links/broken_hash_with_query.html

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+<p><a href="?txthl=avian%20influenza+world+cook+flu-like%20symptoms+Don't%20Forget...+causes%20sickness%20in%20birds,%20it%20can%20also%20infect%20people.#example">Highlight example text that meets the search criteria</a></p>
+
+</body>
+
+</html>

data/spec/html/proofer/fixtures/links/escape_pipes.html

@@ -0,0 +1,9 @@
+<html>
+<head>
+  <link
+    rel="stylesheet"
+    href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic|Noto+Serif:400,400italic,700,700italic|Droid+Sans+Mono:400">
+</head>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/links/folder/index.php

@@ -0,0 +1,2 @@
+<?php
+  x = 42;

data/spec/html/proofer/fixtures/links/link_pointing_to_directory.html

@@ -0,0 +1 @@
+<a href="folder/">Directory</a>

data/spec/html/proofer/links_spec.rb

@@ -45,6 +45,14 @@ describe "Links test" do
     output.should match /External link https:\/\/help.github.com\/changing-author-info\/ failed: 301 No error/
   end
 
+  it "does not fail on redirects we're not following" do
+    # this test should emit a 301--see above--but we're intentionally supressing it
+    options = { :only_4xx => true, :followlocation => false }
+    linkWithRedirectFilepath = "#{FIXTURES_DIR}/links/linkWithRedirect.html"
+    output = capture_stderr { HTML::Proofer.new(linkWithRedirectFilepath, options).run }
+    output.should == ""
+  end
+
   it "should understand https" do
     linkWithHttpsFilepath = "#{FIXTURES_DIR}/links/linkWithHttps.html"
     output = capture_stderr { HTML::Proofer.new(linkWithHttpsFilepath).run }
@@ -173,9 +181,8 @@ describe "Links test" do
   end
 
   it "works for array of links" do
-    options = { :as_link_array => true}
-    output = capture_stderr { HTML::Proofer.new(["www.github.com", "foofoofoo.biz"], options).run }
-    output.should match /foofoo.biz\/? failed: 0 Couldn't resolve host name/
+    output = capture_stderr { HTML::Proofer.new(["www.github.com", "foofoofoo.biz"]).run }
+    output.should match /foofoofoo.biz\/? failed: 0 Couldn't resolve host name/
   end
 
   it "works for broken anchors within pre" do
@@ -189,4 +196,23 @@ describe "Links test" do
     output = capture_stderr { HTML::Proofer.new(link_pre).run }
     output.should == ""
   end
+
+  it "works for pipes in the URL" do
+    escape_pipes = "#{FIXTURES_DIR}/links/escape_pipes.html"
+    output = capture_stderr { HTML::Proofer.new(escape_pipes).run }
+    output.should == ""
+  end
+
+  it "fails for broken hash with query" do
+    broken_hash = "#{FIXTURES_DIR}/links/broken_hash_with_query.html"
+    output = capture_stderr { HTML::Proofer.new(broken_hash).run }
+    output.should match /linking to internal hash #example that does not exist/
+  end
+
+  it "works for directory index file" do
+    options = { :directory_index => "index.php" }
+    link_pointing_to_directory = "#{FIXTURES_DIR}/links/link_pointing_to_directory.html"
+    output = capture_stderr { HTML::Proofer.new(link_pointing_to_directory, options).run }
+    output.should == ""
+  end
 end

data/spec/spec_helper.rb

@@ -12,6 +12,9 @@ RSpec.configure do |config|
 
   # Use the specified formatter
   config.formatter = :documentation # :progress, :html, :textmate
+
+  # Run in a random order
+  config.order = :random
 end
 
 def capture_stderr(&block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -81,49 +81,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: html-pipeline
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: escape_utils
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -160,6 +160,7 @@ files:
 - lib/html/proofer/checks/images.rb
 - lib/html/proofer/checks/links.rb
 - lib/html/proofer/checks/scripts.rb
+- lib/html/proofer/issue.rb
 - spec/html/proofer/favicon_spec.rb
 - spec/html/proofer/fixtures/favicon/favicon_absent.html
 - spec/html/proofer/fixtures/favicon/favicon_absent_apple.html
@@ -192,10 +193,13 @@ files:
 - spec/html/proofer/fixtures/links/brokenLinkExternal.html
 - spec/html/proofer/fixtures/links/brokenLinkInternal.html
 - spec/html/proofer/fixtures/links/brokenLinkWithNumber.html
+- spec/html/proofer/fixtures/links/broken_hash_with_query.html
 - spec/html/proofer/fixtures/links/checkSSLLinks.html
+- spec/html/proofer/fixtures/links/escape_pipes.html
 - spec/html/proofer/fixtures/links/folder/anchorLink.html
 - spec/html/proofer/fixtures/links/folder/assets/barrel.png
 - spec/html/proofer/fixtures/links/folder/index.html
+- spec/html/proofer/fixtures/links/folder/index.php
 - spec/html/proofer/fixtures/links/folder/relativeImage.html
 - spec/html/proofer/fixtures/links/gpl.png
 - spec/html/proofer/fixtures/links/head_link_href.html
@@ -212,6 +216,7 @@ files:
 - spec/html/proofer/fixtures/links/link_directory_without_slash.html
 - spec/html/proofer/fixtures/links/link_missing_protocol_invalid.html
 - spec/html/proofer/fixtures/links/link_missing_protocol_valid.html
+- spec/html/proofer/fixtures/links/link_pointing_to_directory.html
 - spec/html/proofer/fixtures/links/links_in_pre.html
 - spec/html/proofer/fixtures/links/mailto_link.html
 - spec/html/proofer/fixtures/links/missingLinkHref.html
@@ -297,10 +302,13 @@ test_files:
 - spec/html/proofer/fixtures/links/brokenLinkExternal.html
 - spec/html/proofer/fixtures/links/brokenLinkInternal.html
 - spec/html/proofer/fixtures/links/brokenLinkWithNumber.html
+- spec/html/proofer/fixtures/links/broken_hash_with_query.html
 - spec/html/proofer/fixtures/links/checkSSLLinks.html
+- spec/html/proofer/fixtures/links/escape_pipes.html
 - spec/html/proofer/fixtures/links/folder/anchorLink.html
 - spec/html/proofer/fixtures/links/folder/assets/barrel.png
 - spec/html/proofer/fixtures/links/folder/index.html
+- spec/html/proofer/fixtures/links/folder/index.php
 - spec/html/proofer/fixtures/links/folder/relativeImage.html
 - spec/html/proofer/fixtures/links/gpl.png
 - spec/html/proofer/fixtures/links/head_link_href.html
@@ -317,6 +325,7 @@ test_files:
 - spec/html/proofer/fixtures/links/link_directory_without_slash.html
 - spec/html/proofer/fixtures/links/link_missing_protocol_invalid.html
 - spec/html/proofer/fixtures/links/link_missing_protocol_valid.html
+- spec/html/proofer/fixtures/links/link_pointing_to_directory.html
 - spec/html/proofer/fixtures/links/links_in_pre.html
 - spec/html/proofer/fixtures/links/mailto_link.html
 - spec/html/proofer/fixtures/links/missingLinkHref.html