html-proofer 0.0.1 → 0.0.3

data/Gemfile.lock

@@ -1,14 +1,33 @@
 PATH
   remote: .
   specs:
-    html-proofer (0.0.1)
+    html-proofer (0.0.2)
+      colored (~> 1.2)
       nokogiri (~> 1.5.6)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    colored (1.2)
     diff-lcs (1.2.1)
+    escape_utils (0.3.2)
+    gemoji (1.4.0)
+    github-markdown (0.5.3)
+    html-pipeline (0.0.8)
+      activesupport (>= 2)
+      escape_utils (~> 0.2)
+      gemoji (~> 1.0)
+      github-markdown (~> 0.5)
+      nokogiri (~> 1.4)
+      rinku (~> 1.7)
+      sanitize (~> 2.0)
+    i18n (0.6.4)
+    multi_json (1.6.1)
     nokogiri (1.5.6)
+    rinku (1.7.2)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -17,10 +36,13 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.0)
+    sanitize (2.0.3)
+      nokogiri (>= 1.4.4, < 1.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  html-pipeline (~> 0.0.7)
   html-proofer!
   rspec (~> 2.13.0)

data/README.md

@@ -20,8 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
-Require the gem; generate some HTML; then `call` the `HTML::Proofer` on 
-your out folder:
+Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on 
+your out folder; then `run` it:
 
 ```ruby
 require 'html/proofer'
@@ -51,9 +51,11 @@ tester = HTML::Proofer.new("./out")
 tester.run
 ```
 
-The `HTML::Proofer` constructor takes on optional hash of additional options:
+The `HTML::Proofer` constructor takes an optional hash of additional options:
 
-* `:ext`: the extension (including the `.`) of your HTML files (default: `.html)
+* `: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`)
 
 ## What's Tested?
 

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/html-proofer.rb

@@ -0,0 +1 @@
+require 'html/proofer'

data/lib/html/proofer.rb

@@ -3,17 +3,23 @@ require 'html/proofer/checks'
 
 module HTML
   class Proofer
-    def initialize(src, opts = {:ext => ".html"})
+    def initialize(src, opts={})
       @srcDir = src
-      @options = opts
+      @options = {:ext => ".html"}.merge(opts)
     end
 
     def run
-      Find.find(@srcDir) do |path|
-        if File.extname(path) == @options[:ext]
-          html = HTML::Proofer.create_nokogiri(path)
-          issues = run_checks(path, html)
-          self.print_issues(issues)
+      get_checks.each do |klass|
+        issues = []
+        puts "Running #{klass.name.split(/:/).pop()} check... \n\n"
+
+        Find.find(@srcDir) do |path|
+          if File.extname(path) == @options[:ext]
+            html = HTML::Proofer.create_nokogiri(path)
+            check = klass.new(path, html, @options)
+            check.run
+            self.print_issues(check.issues)
+          end
         end
       end
     end
@@ -26,20 +32,6 @@ module HTML
       HTML::Proofer::Checks::Check.subclasses
     end
 
-    def run_checks(path, html)
-      issues = []
-
-      get_checks.each do |klass|
-        puts "Running #{klass.name.split(/:/).pop()} check... "
-
-        check = klass.new(path, html)
-        check.run
-
-        issues.concat(check.issues)
-      end
-      issues
-    end
-
     def print_issues(issues)
       return if issues.empty?
       issues.each do |issue|

data/lib/html/proofer/check.rb

@@ -11,10 +11,13 @@ class HTML::Proofer::Checks
 
     attr_reader :issues
 
-    def initialize(path, html)
+    def initialize(path, html, opts={})
       @path   = path
       @html   = html
+      @options = opts
       @issues = []
+
+      @additional_href_ignores = @options[:href_ignore] || []
     end
 
     def run
@@ -38,6 +41,15 @@ class HTML::Proofer::Checks
       false
     end
 
+    def ignore_href?(href)
+      uri = URI.parse(href)
+      %w( mailto ).include?(uri.scheme) || @additional_href_ignores.include?(href)
+    rescue URI::BadURIError
+      false
+    rescue URI::InvalidURIError
+      false
+    end
+
     def validate_url(href)
       # Parse
       url = nil
@@ -47,9 +59,6 @@ class HTML::Proofer::Checks
         return Result.new(href, 'invalid URI')
       end
 
-      # Skip non-HTTP URLs
-      #return nil if url.scheme !~ /^https?$/
-
       # Get status
       res = nil
       5.times do |i|
@@ -61,11 +70,9 @@ class HTML::Proofer::Checks
           return nil
         end
 
+        next if res.code =~ /^5..$/
+        
         if res.code =~ /^3..$/
-          if i == 4
-            return nil
-          end
-
           # Find proper location
           location = res['Location']
           if location !~ /^https?:\/\//
@@ -75,7 +82,6 @@ class HTML::Proofer::Checks
             base_url.fragment = nil
             location = base_url.to_s + location
           end
-          puts location
           url = URI.parse(location)
         elsif res.code == '200'
           return true

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

@@ -18,7 +18,7 @@ class Images < ::HTML::Proofer::Checks::Check
       end
 
       # check alt tag
-      self.add_issue("#{@path}".blue + ": image #{src} does not have an alt attribute") unless img['alt']
+      self.add_issue("#{@path}".blue + ": image #{src} does not have an alt attribute") unless img['alt'] and !img['alt'].empty?
     end
   end
 end

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

@@ -7,6 +7,14 @@ class Links < ::HTML::Proofer::Checks::Check
       href = a['href']
 
       if href && href.length > 0
+        if @options[:href_swap] 
+          @options[:href_swap].each do |link, replace|
+            href = href.gsub(link, replace)
+          end
+        end
+
+        return if ignore_href?(href)
+
         if href.include? '#'
           href_split = href.split('#')
         end
@@ -24,26 +32,30 @@ class Links < ::HTML::Proofer::Checks::Check
               else
                 href_html = HTML::Proofer.create_nokogiri(href_location)
                 found_hash_match = false
-                unless href_html.search("[id=#{href_hash}]", "[name=#{href_hash}]").length > 0
+                unless hash_check(href_html, href_hash)
                   self.add_issue("#{@path}".blue + ": linking to #{href}, but #{href_hash} does not exist")
                 end
               end
             # it is an internal link, with an internal hash
             else
-              unless @html.search("[id=#{href_hash}]", "[name=#{href_hash}]").length > 0
+              unless hash_check(@html, href_hash)
                 self.add_issue("#{@path}".blue + ": linking to an internal hash called #{href_hash} that does not exist")
               end
             end
           # internal link, no hash
           else
-            self.add_issue("#{@path}".blue + ": linking to #{href}, which does not exist") unless File.exist?(File.join(File.dirname(@path), href))
+            self.add_issue("#{@path}".blue + ": internally linking to #{href}, which does not exist") unless File.exist?(File.join(File.dirname(@path), href))
           end
         else
-          self.add_issue("#{@path}".blue + ": linking to #{href}, which does not exist") unless validate_url(href)
+          self.add_issue("#{@path}".blue + ": externally linking to #{href}, which does not exist") unless validate_url(href)
         end
       else
         self.add_issue("#{@path}".blue + ": link has no href attribute") unless a['name'] || a['id']
       end
     end
   end
+
+  def hash_check(html, href_hash)
+    html.xpath("//*[@id='#{href_hash}']", "//*[@name='#{href_hash}']").length > 0
+  end
 end

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

data/spec/html/proofer/fixtures/brokenLinkWithNumber.html

@@ -0,0 +1,8 @@
+<html>
+
+<body>
+
+	<p>Blah blah blah. <a name="25-method-not-allowed" class="anchor" href="#25-method-not-allowed"><span class="mini-icon mini-icon-link"></span></a>25 Method not allowed</h4></p>
+</body>
+
+</html>

data/spec/html/proofer/fixtures/linkWithHttps.html

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+	<p>Blah blah blah. <a href="https://github.com/octocat/Spoon-Knife/issues">An HTTPS link!</a></p>
+
+</body>
+
+</html>

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

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+	<p>Blah blah blah. <a href="http://www.capify.org/">This is a redirect.</a>. </p>
+
+</body>
+
+</html>

data/spec/html/proofer/fixtures/missingImageAltText.html

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+	<p>Blah blah blah. <img src="./gpl.png" alt/> </p>
+
+</body>
+
+</html>

data/spec/html/proofer/images_spec.rb

@@ -1,46 +1,52 @@
 require "spec_helper"
-include HTML::Proofer::Checks
 
-describe "Image" do
+describe "Image tests" do
   it "passes for existing external images" do
     externalImageFilepath = "#{FIXTURES_DIR}/existingImageExternal.html"
-    @imageCheck = ::HTML::Proofer::Checks::Check::Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
+    @imageCheck = Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
     @imageCheck.run
     @imageCheck.issues[0].should eq(nil)
   end
 
   it "fails for image without alt attribute" do
     missingAltFilepath = "#{FIXTURES_DIR}/missingImageAlt.html"
-    @imageCheck = ::HTML::Proofer::Checks::Check::Images.new(missingAltFilepath, HTML::Proofer.create_nokogiri(missingAltFilepath))
+    @imageCheck = Images.new(missingAltFilepath, HTML::Proofer.create_nokogiri(missingAltFilepath))
     @imageCheck.run
-    @imageCheck.issues[0].should eq("In spec/html/proofer/fixtures/missingImageAlt.html, image ./gpl.png does not have an alt attribute")
+    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageAlt.html".blue + ": image ./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(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")
   end
 
   it "fails for image without a dir prefix" do
     missingImageDirPrefixFilepath = "#{FIXTURES_DIR}/missingImageDirPrefix.html"
-    @imageCheck = ::HTML::Proofer::Checks::Check::Images.new(missingImageDirPrefixFilepath, HTML::Proofer.create_nokogiri(missingImageDirPrefixFilepath))
+    @imageCheck = Images.new(missingImageDirPrefixFilepath, HTML::Proofer.create_nokogiri(missingImageDirPrefixFilepath))
     @imageCheck.run
-    @imageCheck.issues[0].should eq("In spec/html/proofer/fixtures/missingImageDirPrefix.html, internal image /gpl.png does not exist")
+    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageDirPrefix.html".blue + ": internal image /gpl.png does not exist")
   end
 
   it "fails for missing external images" do
     externalImageFilepath = "#{FIXTURES_DIR}/missingImageExternal.html"
-    @imageCheck = ::HTML::Proofer::Checks::Check::Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
+    @imageCheck = Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
     @imageCheck.run
-    @imageCheck.issues[0].should eq("In spec/html/proofer/fixtures/missingImageExternal.html, external image http://www.whatthehell does not exist")
+    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageExternal.html".blue + ": external image http://www.whatthehell does not exist")
   end
 
   it "fails for missing internal images" do
     internalImageFilepath = "#{FIXTURES_DIR}/missingImageInternal.html"
-    @imageCheck = ::HTML::Proofer::Checks::Check::Images.new(internalImageFilepath, HTML::Proofer.create_nokogiri(internalImageFilepath))
+    @imageCheck = Images.new(internalImageFilepath, HTML::Proofer.create_nokogiri(internalImageFilepath))
     @imageCheck.run
-    @imageCheck.issues[0].should eq("In spec/html/proofer/fixtures/missingImageInternal.html, internal image ./doesnotexist.png does not exist")
+    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageInternal.html".blue + ": internal image ./doesnotexist.png does not exist")
   end
 
   it "fails for image with no src" do
     imageSrcFilepath = "#{FIXTURES_DIR}/missingImageSrc.html"
-    @imageCheck = ::HTML::Proofer::Checks::Check::Images.new(imageSrcFilepath, HTML::Proofer.create_nokogiri(imageSrcFilepath))
+    @imageCheck = Images.new(imageSrcFilepath, HTML::Proofer.create_nokogiri(imageSrcFilepath))
     @imageCheck.run
-    @imageCheck.issues[0].should eq("In spec/html/proofer/fixtures/missingImageSrc.html, image has no src attribute")
+    @imageCheck.issues[0].should eq("spec/html/proofer/fixtures/missingImageSrc.html".blue + ": image has no src attribute")
   end
 end

data/spec/html/proofer/links_spec.rb

@@ -1,40 +1,60 @@
 require "spec_helper"
-include HTML::Proofer::Checks
 
-describe "Links" do
+describe "Links tests" do
 
   it "fails for broken external hash (even if the file exists)" do
     brokenHashExternalFilepath = "#{FIXTURES_DIR}/brokenHashExternal.html"
-    @linkCheck = ::HTML::Proofer::Checks::Check::Links.new(brokenHashExternalFilepath, HTML::Proofer.create_nokogiri(brokenHashExternalFilepath))
+    @linkCheck = Links.new(brokenHashExternalFilepath, HTML::Proofer.create_nokogiri(brokenHashExternalFilepath))
     @linkCheck.run
-    @linkCheck.issues[1].should eq("spec/html/proofer/fixtures/brokenHashExternal.html is linking to ./missingImageAlt.html#asdfasfdkafl, but asdfasfdkafl does not exist")
+    @linkCheck.issues[1].should eq("spec/html/proofer/fixtures/brokenHashExternal.html".blue + ": linking to ./missingImageAlt.html#asdfasfdkafl, but asdfasfdkafl does not exist")
   end
 
   it "fails for broken internal hash" do
     brokenHashInternalFilepath = "#{FIXTURES_DIR}/brokenHashInternal.html"
-    @linkCheck = ::HTML::Proofer::Checks::Check::Links.new(brokenHashInternalFilepath, HTML::Proofer.create_nokogiri(brokenHashInternalFilepath))
+    @linkCheck = Links.new(brokenHashInternalFilepath, HTML::Proofer.create_nokogiri(brokenHashInternalFilepath))
     @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenHashInternal.html is linking to an internal hash called noHash that does not exist")
+    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenHashInternal.html".blue + ": linking to an internal hash called noHash that does not exist")
   end
 
   it "fails for broken external links" do
     brokenLinkExternalFilepath = "#{FIXTURES_DIR}/brokenLinkExternal.html"
-    @linkCheck = ::HTML::Proofer::Checks::Check::Links.new(brokenLinkExternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkExternalFilepath))
+    @linkCheck = Links.new(brokenLinkExternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkExternalFilepath))
     @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkExternal.html is linking to http://www.asdo3IRJ395295jsingrkrg4.com, which does not exist")
+    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkExternal.html".blue + ": externally linking to http://www.asdo3IRJ395295jsingrkrg4.com, which does not exist")
   end
 
   it "fails for broken internal links" do
     brokenLinkInternalFilepath = "#{FIXTURES_DIR}/brokenLinkInternal.html"
-    @linkCheck = ::HTML::Proofer::Checks::Check::Links.new(brokenLinkInternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkInternalFilepath))
+    @linkCheck = Links.new(brokenLinkInternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkInternalFilepath))
     @linkCheck.run
-    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkInternal.html is linking to ./notreal.html, which does not exist")
+    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/brokenLinkInternal.html".blue + ": internally linking to ./notreal.html, which does not exist")
   end
 
   it "fails for link with no href" do
     missingLinkHrefFilepath = "#{FIXTURES_DIR}/missingLinkHref.html"
-    @linkCheck = ::HTML::Proofer::Checks::Check::Links.new(missingLinkHrefFilepath, HTML::Proofer.create_nokogiri(missingLinkHrefFilepath))
+    @linkCheck = Links.new(missingLinkHrefFilepath, HTML::Proofer.create_nokogiri(missingLinkHrefFilepath))
     @linkCheck.run
-    @linkCheck.issues[0].should eq("In spec/html/proofer/fixtures/missingLinkHref.html, link has no href attribute")
+    @linkCheck.issues[0].should eq("spec/html/proofer/fixtures/missingLinkHref.html".blue + ": link has no href attribute")
+  end
+
+  it "should follow redirects" do
+    linkWithRedirectFilepath = "#{FIXTURES_DIR}/linkWithRedirect.html"
+    @linkCheck = Links.new(linkWithRedirectFilepath, HTML::Proofer.create_nokogiri(linkWithRedirectFilepath))
+    @linkCheck.run
+    @linkCheck.issues[0].should eq(nil)
+  end
+
+  it "should understand https" do
+    linkWithHttpsFilepath = "#{FIXTURES_DIR}/linkWithHttps.html"
+    @linkCheck = Links.new(linkWithHttpsFilepath, HTML::Proofer.create_nokogiri(linkWithHttpsFilepath))
+    @linkCheck.run
+    @linkCheck.issues[0].should eq(nil)
+  end
+
+  it "fails for broken hash links with status code numbers" do
+    brokenLinkWithNumberFilepath = "#{FIXTURES_DIR}/brokenLinkWithNumber.html"
+    @linkCheck = Links.new(brokenLinkWithNumberFilepath, HTML::Proofer.create_nokogiri(brokenLinkWithNumberFilepath))
+    @linkCheck.run
+    @linkCheck.issues[0].should eq(nil)
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,17 @@
 require 'bundler/setup'
-require_relative "../lib/html/proofer.rb"
-require_relative "../lib/html/proofer/checks.rb"
+require_relative "../lib/html-proofer"
 
 require File.expand_path('../../lib/html/proofer/version.rb', __FILE__)
 
-FIXTURES_DIR = "spec/html/proofer/fixtures"
+FIXTURES_DIR = "spec/html/proofer/fixtures"
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -87,7 +87,9 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
 - html-proofer.gemspec
+- lib/html-proofer.rb
 - lib/html/proofer.rb
 - lib/html/proofer/check.rb
 - lib/html/proofer/checks.rb
@@ -98,9 +100,13 @@ files:
 - spec/html/proofer/fixtures/brokenHashInternal.html
 - spec/html/proofer/fixtures/brokenLinkExternal.html
 - spec/html/proofer/fixtures/brokenLinkInternal.html
+- spec/html/proofer/fixtures/brokenLinkWithNumber.html
 - spec/html/proofer/fixtures/existingImageExternal.html
 - spec/html/proofer/fixtures/gpl.png
+- spec/html/proofer/fixtures/linkWithHttps.html
+- spec/html/proofer/fixtures/linkWithRedirect.html
 - spec/html/proofer/fixtures/missingImageAlt.html
+- spec/html/proofer/fixtures/missingImageAltText.html
 - spec/html/proofer/fixtures/missingImageDirPrefix.html
 - spec/html/proofer/fixtures/missingImageExternal.html
 - spec/html/proofer/fixtures/missingImageInternal.html
@@ -141,9 +147,13 @@ test_files:
 - spec/html/proofer/fixtures/brokenHashInternal.html
 - spec/html/proofer/fixtures/brokenLinkExternal.html
 - spec/html/proofer/fixtures/brokenLinkInternal.html
+- spec/html/proofer/fixtures/brokenLinkWithNumber.html
 - spec/html/proofer/fixtures/existingImageExternal.html
 - spec/html/proofer/fixtures/gpl.png
+- spec/html/proofer/fixtures/linkWithHttps.html
+- spec/html/proofer/fixtures/linkWithRedirect.html
 - spec/html/proofer/fixtures/missingImageAlt.html
+- spec/html/proofer/fixtures/missingImageAltText.html
 - spec/html/proofer/fixtures/missingImageDirPrefix.html
 - spec/html/proofer/fixtures/missingImageExternal.html
 - spec/html/proofer/fixtures/missingImageInternal.html