html-proofer 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e3804b2c58cfc45bef2a6de1a8a2e97ccd6132
-  data.tar.gz: f0cff86b5f52382e228090a6aa5992815ea3d9de
+  metadata.gz: 65952ba4e5dea5147b84fb88dfae41a49d432340
+  data.tar.gz: a127df0cb3040eba53860c640255678baf4df3d3
 SHA512:
-  metadata.gz: cc7bc7d35c99e356ea94c69472957f923f117f18ac119c8ce147794ad6ba6cc9dab9369ef244c8cb9498a92e9a823e14f77e88a89d564a701af66dbc65d2d7ca
-  data.tar.gz: be3629b356a39521baa248e6e4a705ba625d9bca4dc697ba5dfdab7344228dbe2c4a104293a73019387eb0ab4593e8d1af96c95272c54393a2b285bc5b7d69dc
+  metadata.gz: 878ed21acbf0ed474580c29bd438dd32e645750480f88e16f675bd579ae3c8fc7b8c216c357caecbfd34944c3cbef3c9b5932fef57ba2f6ce09abbbcc03f23cf
+  data.tar.gz: 740b6aaaa8df3bed83b6194ff27ba85810dbd035e30cb45410fabb2050bcb94ba485e67531cec6c790ad7194523da23c2291796e6797ca192b66dfc805c2123d

data/README.md

@@ -107,15 +107,25 @@ htmlproof ./_site
 * Whether your internal links are not broken; this includes hash references (`#linkToMe`)
 * Whether external links are working
 
+### Scripts
+
+`script` elements:
+
+* Whether your internal script references are not broken
+* Whether external scripts are loading
+
 ## 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 or RegExps containing `href`s that are safe to ignore (certain URIs, like `mailto` and `tel`, are always ignored)
-* `:disable_external`: if `true`, does not run the external link checker, which can take a lot of time (default: `false`)
-* `:verbose`: if `true`, outputs extra information as the checking happens. Useful for debugging. (default: `false`)
+| Option | Description | Default |
+| :----- | :---------- | :------ |
+| `disable_external` | If `true`, does not run the external link checker, which can take a lot of time. | `false` |
+| `ext` | The extension of your HTML files including the dot. | `.html` |
+| `favicon` | Enables the favicon checker. | `false` |
+| `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. | `[]` |
+| `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` |
 
 You can also pass in any of Typhoeus' options for the external link check. For example:
 

data/bin/htmlproof

@@ -15,6 +15,7 @@ Mercenary.program(:htmlproof) do |p|
   p.description "Runs the HTML-Proofer suite on the files in PATH"
 
   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 '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 'ignore', '--ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore (default: `mailto`)'
   p.option 'disable_external', '--disable_external', 'Disables the external link checker (default: `false`)'
@@ -35,6 +36,7 @@ Mercenary.program(:htmlproof) do |p|
     end
     options[:href_ignore] = opts["ignore"] unless opts["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?
 
     HTML::Proofer.new(path, options).run

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       = "0.8.0"
+  gem.version       = "0.9.0"
   gem.authors       = ["Garen Torikian"]
   gem.email         = ["gjtorikian@gmail.com"]
   gem.description   = %q{Test your rendered HTML files to make sure they're accurate.}

data/lib/html/proofer.rb

@@ -13,7 +13,14 @@ module HTML
     def initialize(src, opts={})
       @srcDir = src
 
-      @proofer_opts = {:ext => ".html", :href_swap => [], :href_ignore => [], :disable_external => false, :verbose => false }
+      @proofer_opts = {
+        :ext => ".html",
+        :favicon => false,
+        :href_swap => [],
+        :href_ignore => [],
+        :disable_external => false,
+        :verbose => false
+      }
       @options = @proofer_opts.merge({:followlocation => true}).merge(opts)
 
       @failed_tests = []
@@ -74,8 +81,8 @@ module HTML
       if @failed_tests.empty?
         logger.info "HTML-Proofer finished successfully.".green
       else
-        @failed_tests.each do |issue|
-          logger.error (issue + "\n\n").red
+        @failed_tests.sort.each do |issue|
+          logger.error issue.to_s.red
         end
 
         raise "HTML-Proofer found #{@failed_tests.length} failures!".red

data/lib/html/proofer/checkable.rb

@@ -7,7 +7,10 @@ module HTML
         @alt = obj['alt']
         @name = obj['name']
         @id = obj['id']
+        @rel = obj['rel']
+
         @data_ignore_proofer = obj['data-proofer-ignore']
+        @content = obj.content
         @check = check
         @checked_paths = {}
         @type = type
@@ -55,16 +58,12 @@ module HTML
       rescue URI::BadURIError
         false
       rescue URI::InvalidURIError
-        if @type == "image"
-          @ignored = true
-          return true if url.match(/^data:image/)
-        end
-
         false
       end
 
       def ignore?
-        return true if @ignored || @data_ignore_proofer || @check.additional_href_ignores.include?(url)
+        return true if @data_ignore_proofer || @check.additional_href_ignores.include?(url)
+        return true if @type == "image" and url.match(/^data:image/)
         unless @check.additional_href_ignores.empty?
           @check.additional_href_ignores.each do |href_ignore|
             if href_ignore.is_a? String
@@ -108,7 +107,7 @@ module HTML
 
         file = File.join base, path
 
-        # implicit /index.html support, with support for tailing slashes
+        # implicit /index.html support, with support for trailing slashes
         file = File.join path, "index.html" if File.directory? File.expand_path file, @check.src
 
         file

data/lib/html/proofer/checks.rb

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

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

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+class Favicon < ::HTML::Proofer::Checkable
+  def rel
+    @rel
+  end
+end
+
+class Favicons < ::HTML::Proofer::Checks::Check
+
+  def run
+    return unless @options[:favicon]
+
+    @html.css("link").each do |favicon|
+      favicon = Favicon.new favicon, "favicon", self
+      return if favicon.rel.split(" ").last.eql? "icon"
+    end
+
+    self.add_issue "no favicon specified"
+  end
+
+end

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

@@ -27,18 +27,20 @@ class Images < ::HTML::Proofer::Checks::Check
     @html.css('img').each do |i|
       img = Image.new i, "image", self
 
+      next if img.ignore?
+
       # screenshot filenames should return because of terrible names
       next 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?
-        next if img.ignore?
-        add_to_external_urls img.src
       else
-        next if img.ignore?
-        self.add_issue("internal image #{img.src} does not exist") unless img.exists?
+        if img.remote?
+          add_to_external_urls img.src
+        else
+          self.add_issue("internal image #{img.src} does not exist") unless img.exists?
+        end
       end
 
       # check alt tag

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

@@ -10,6 +10,10 @@ 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
@@ -18,14 +22,14 @@ class Links < ::HTML::Proofer::Checks::Check
     @html.css('a, link').each do |l|
       link = Link.new l, "link", self
 
+      next if link.ignore?
+
       # is it even a valid URL?
       unless link.valid?
         self.add_issue "#{link.href} is an invalid URL"
         next
       end
 
-      next if link.ignore?
-
       # is there even a href?
       if link.missing_href?
         self.add_issue("link has no href attribute")
@@ -39,6 +43,12 @@ class Links < ::HTML::Proofer::Checks::Check
         self.add_issue "internally linking to #{link.href}, which does not exist" unless link.exists?
       end
 
+      # has the local directory a trailing slash?
+      if !@options[:followlocation] and !link.remote? and link.unslashed_directory?
+        self.add_issue("internally linking to a directory #{link.absolute_path} without trailing slash")
+        next
+      end
+
       # verify the target hash
       if link.hash
         if link.remote?

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

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+class Script < ::HTML::Proofer::Checkable
+
+  def src
+    @src unless @src.nil? || @src.empty?
+  end
+
+  def missing_src?
+    !src
+  end
+
+  def blank?
+    @content.strip.empty?
+  end
+
+end
+
+class Scripts < ::HTML::Proofer::Checks::Check
+  def run
+    @html.css('script').each do |s|
+      script = Script.new s, "script", self
+
+      next if script.ignore?
+      next unless script.blank?
+
+      # does the script exist?
+      if script.missing_src?
+        self.add_issue "script is empty and has no src attribute"
+      elsif script.remote?
+        add_to_external_urls script.src
+      else
+        self.add_issue("internal script #{script.src} does not exist") unless script.exists?
+      end
+
+    end
+
+    external_urls
+  end
+end

data/spec/html/proofer/favicon_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe "Favicons test" do
+  it "ignores for absent favicon by default" do
+    absent = "#{FIXTURES_DIR}/favicon/favicon_absent.html"
+    output = capture_stderr { HTML::Proofer.new(absent).run }
+    output.should == ""
+  end
+
+  it "fails for absent favicon" do
+    absent = "#{FIXTURES_DIR}/favicon/favicon_absent.html"
+    output = capture_stderr { HTML::Proofer.new(absent, {:favicon => true}).run }
+    output.should match /no favicon specified/
+  end
+
+  it "fails for absent favicon but present apple touch icon" do
+    absent = "#{FIXTURES_DIR}/favicon/favicon_absent_apple.html"
+    output = capture_stderr { HTML::Proofer.new(absent, {:favicon => true}).run }
+    output.should match /no favicon specified/
+  end
+
+  it "fails for broken favicon" do
+    broken = "#{FIXTURES_DIR}/favicon/favicon_broken.html"
+    output = capture_stderr { HTML::Proofer.new(broken, {:favicon => true}).run }
+    output.should match /internally linking to asdadaskdalsdk.png/
+  end
+
+  it "passes for present favicon" do
+    present = "#{FIXTURES_DIR}/favicon/favicon_present.html"
+    output = capture_stderr { HTML::Proofer.new(present, {:favicon => true}).run }
+    output.should == ""
+  end
+
+  it "passes for present favicon with shortcut notation" do
+    present = "#{FIXTURES_DIR}/favicon/favicon_present_shortcut.html"
+    output = capture_stderr { HTML::Proofer.new(present, {:favicon => true}).run }
+    output.should == ""
+  end
+
+  it "passes 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 == ""
+  end
+
+end

data/spec/html/proofer/fixtures/favicon/favicon_absent.html

@@ -0,0 +1,4 @@
+<html>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/favicon/favicon_absent_apple.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+  <link rel="apple-touch-icon" href="gpl.png">
+</head>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/favicon/favicon_broken.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+  <link rel="icon" href="asdadaskdalsdk.png">
+</head>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/favicon/favicon_broken_but_ignored.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+  <link rel="icon" href="asdadaskdalsdk.png" data-proofer-ignore>
+</head>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/favicon/favicon_present.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+  <link rel="icon" href="../resources/gpl.png">
+</head>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/favicon/favicon_present_shortcut.html

@@ -0,0 +1,7 @@
+<html>
+<head>
+  <link rel="shortcut icon" href="../resources/gpl.png">
+</head>
+<body>
+</body>
+</html>

data/spec/html/proofer/fixtures/images/relativeToSelf.html

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

data/spec/html/proofer/fixtures/{brokenHashExternal.html → links/brokenHashExternal.html}

@@ -3,9 +3,9 @@
 <body>
 
 <p>Blah blah blah. <a href="./notarealhash.html#noHash">Not a real file, don't even bother with hash!</a></p>
-<p>Blah blah blah. <a href="./missingImageAlt.html#asdfasfdkafl">A real file, not a real hash!</a></p>
+<p>Blah blah blah. <a href="../images/missingImageAlt.html#asdfasfdkafl">A real file, not a real hash!</a></p>
 <a href="./brokenLinkInternal.html#safeHash">At last, a real hash link.</a>
 
 </body>
 
-</html>
+</html>