html-proofer 0.0.9 → 0.0.10

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    html-proofer (0.0.2)
+    html-proofer (0.0.10)
       colored (~> 1.2)
       nokogiri (~> 1.5.6)
+      typhoeus (~> 0.6.3)
 
 GEM
   remote: http://rubygems.org/
@@ -14,6 +15,10 @@ GEM
     colored (1.2)
     diff-lcs (1.2.1)
     escape_utils (0.3.2)
+    ethon (0.5.12)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    ffi (1.9.0)
     gemoji (1.4.0)
     github-markdown (0.5.3)
     html-pipeline (0.0.8)
@@ -25,6 +30,7 @@ GEM
       rinku (~> 1.7)
       sanitize (~> 2.0)
     i18n (0.6.4)
+    mime-types (1.23)
     multi_json (1.6.1)
     nokogiri (1.5.6)
     rinku (1.7.2)
@@ -38,6 +44,8 @@ GEM
     rspec-mocks (2.13.0)
     sanitize (2.0.3)
       nokogiri (>= 1.4.4, < 1.6)
+    typhoeus (0.6.3)
+      ethon (~> 0.5.11)
 
 PLATFORMS
   ruby

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on 
+Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on
 your out folder; then `run` it:
 
 ```ruby
@@ -56,7 +56,6 @@ 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`)
-* `:longTests`: a Boolean indicating if long-running tests should run (for example, tests checking external links)
 
 ## What's Tested?
 
@@ -64,4 +63,4 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 * Whether your internal image references are not broken
 * Whether external images are showing
 * Whether your internal links are not broken; this includes hash references (`#linkToMe`)
-* Whether external links are working
+* Whether external links are working

data/html-proofer.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "nokogiri",        "~> 1.5.6"
   gem.add_dependency "colored",         "~> 1.2"
+  gem.add_dependency "typhoeus",        "~> 0.6.3"
 
   gem.add_development_dependency "html-pipeline", "~> 0.0.7"
   gem.add_development_dependency "rspec", "~> 2.13.0"

data/lib/html/proofer.rb

@@ -18,6 +18,7 @@ module HTML
             html = HTML::Proofer.create_nokogiri(path)
             check = klass.new(path, html, @options)
             check.run
+            check.hydra.run
             self.print_issues(klass, check.issues)
           end
         end

data/lib/html/proofer/check.rb

@@ -4,12 +4,13 @@ require 'net/https'
 require 'timeout'
 require 'uri'
 require 'colored'
+require 'typhoeus'
 
 class HTML::Proofer::Checks
 
   class Check
 
-    attr_reader :issues
+    attr_reader :issues, :hydra
 
     def initialize(path, html, opts={})
       @path   = path
@@ -17,6 +18,7 @@ class HTML::Proofer::Checks
       @options = opts
       @issues = []
 
+      @hydra = Typhoeus::Hydra.hydra
       @additional_href_ignores = @options[:href_ignore] || []
     end
 
@@ -50,48 +52,22 @@ class HTML::Proofer::Checks
       false
     end
 
-    def validate_url(href)
-      return true unless @options[:longTests]
-
-      # Parse
-      url = nil
-      begin
-        url = URI.parse(href)
-      rescue URI::InvalidURIError
-        return Result.new(href, 'invalid URI')
-      end
-
-      # Get status
-      res = nil
-      5.times do |i|
-        begin
-          Timeout::timeout(10) do
-            res = request_url(url)
-          end
-        rescue => e
-          return nil
-        end
-
-        next if res.code =~ /^5..$/
-        
-        if res.code =~ /^3..$/
-          # Find proper location
-          location = res['Location']
-          if location !~ /^https?:\/\//
-            base_url = url.dup
-            base_url.path = (location =~ /^\// ? '' : '/')
-            base_url.query = nil
-            base_url.fragment = nil
-            location = base_url.to_s + location
-          end
-          url = URI.parse(location)
-        elsif res.code == '200'
-          return true
+    def validate_url(href, issue_text)
+      request = Typhoeus::Request.new(href)
+      request.on_complete do |response|
+        if response.success?
+          # no op
+        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}")
         else
-          return nil
+          # Received a non-successful http response.
+          self.add_issue(issue_text + " HTTP request failed: " + response.code.to_s)
         end
       end
-      raise 'should not have gotten here'
+      hydra.queue(request)
     end
 
     def request_url(url)

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

@@ -11,7 +11,7 @@ class Images < ::HTML::Proofer::Checks::Check
         if !external_href?(src)
           self.add_issue("#{@path}".blue + ": internal image #{src} does not exist") unless src[0] != "/" and File.exist?(File.join(File.dirname(@path), src))
         else
-          self.add_issue("#{@path}".blue + ": external image #{src} does not exist") unless validate_url(src)
+          validate_url(src, "#{@path}".blue + ": external image #{src} does not exist")
         end
       else
         self.add_issue("#{@path}".blue + ": image has no src attribute")

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

@@ -47,7 +47,7 @@ class Links < ::HTML::Proofer::Checks::Check
             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 + ": externally linking to #{href}, which does not exist") unless validate_url(href)
+          validate_url(href, "#{@path}".blue + ": externally linking to #{href}, which does not exist")
         end
       else
         self.add_issue("#{@path}".blue + ": link has no href attribute") unless a['name'] || a['id']

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = "0.0.9"
+    VERSION = "0.0.10"
   end
 end

data/spec/html/proofer/images_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe "Image tests" do
   it "passes for existing external images" do
     externalImageFilepath = "#{FIXTURES_DIR}/existingImageExternal.html"
-    @imageCheck = Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath), {:longTests => true})
+    @imageCheck = Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath))
     @imageCheck.run
     @imageCheck.issues[0].should eq(nil)
   end
@@ -31,8 +31,10 @@ describe "Image tests" do
 
   it "fails for missing external images" do
     externalImageFilepath = "#{FIXTURES_DIR}/missingImageExternal.html"
-    @imageCheck = Images.new(externalImageFilepath, HTML::Proofer.create_nokogiri(externalImageFilepath), {:longTests => true})
+    @imageCheck = Images.new(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")
   end
 
@@ -56,4 +58,4 @@ describe "Image tests" do
     @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)")
   end
-end
+end

data/spec/html/proofer/links_spec.rb

@@ -18,8 +18,10 @@ describe "Links tests" do
 
   it "fails for broken external links" do
     brokenLinkExternalFilepath = "#{FIXTURES_DIR}/brokenLinkExternal.html"
-    @linkCheck = Links.new(brokenLinkExternalFilepath, HTML::Proofer.create_nokogiri(brokenLinkExternalFilepath), {:longTests => true})
+    @linkCheck = Links.new(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")
   end
 
@@ -39,14 +41,14 @@ describe "Links tests" do
 
   it "should follow redirects" do
     linkWithRedirectFilepath = "#{FIXTURES_DIR}/linkWithRedirect.html"
-    @linkCheck = Links.new(linkWithRedirectFilepath, HTML::Proofer.create_nokogiri(linkWithRedirectFilepath), {:longTests => true})
+    @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), {:longTests => true})
+    @linkCheck = Links.new(linkWithHttpsFilepath, HTML::Proofer.create_nokogiri(linkWithHttpsFilepath))
     @linkCheck.run
     @linkCheck.issues[0].should eq(nil)
   end
@@ -57,4 +59,4 @@ describe "Links tests" do
     @linkCheck.run
     @linkCheck.issues[0].should eq(nil)
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement