html-proofer 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 251947156251aad2dfb34f8f05b24fe387c34b79
-  data.tar.gz: 0b1ef3155efa7036f09db41e0cd4689002cdf318
+  metadata.gz: c5f9520152e65b775e134ac987d42fdeb69a4448
+  data.tar.gz: 6fb435127a7de49da70d5b9284d95bbb736bc19b
 SHA512:
-  metadata.gz: 9de89df3791ddb7d945fe5e6624fb18db97407364ab070dd5aa0598d9d414baf276f578f2e7aec90db432596da79f4005ff1b9267093921d02c2827cd0ce88fa
-  data.tar.gz: 49e32043dbe5a4fd60f46da560c47185cb7319f769cde383045df9d91fcfd205a6c56266f59274d18f6c889405a5da5b0371283371a45d5129853924c81c42b2
+  metadata.gz: d2e355f14b84c62685a44b01e93109f7d4c6ddad4884c952f4c734c8a473ee22f94a258b09601bac4a648d9d3fa61f0f949d800208296755e5d63be5a4ca6f67
+  data.tar.gz: 9e768b2b3920f5bf61fe1bcd257e890315cbe110c08afec49ba0a8e637341eef5c88f546adeeefcfa079a779b06b09f087ec18b00ed1c21f3f06ec038dd5c4c6

data/Gemfile.lock

@@ -3,7 +3,8 @@ PATH
   specs:
     html-proofer (0.2.3)
       colored (~> 1.2)
-      nokogiri (= 1.6.0)
+      mercenary (~> 0.2.0)
+      nokogiri (~> 1.6.0)
       typhoeus (~> 0.6.3)
 
 GEM
@@ -22,7 +23,7 @@ GEM
     ethon (0.6.1)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
-    ffi (1.9.0)
+    ffi (1.9.3)
     gemoji (1.4.0)
     github-markdown (0.5.5)
     html-pipeline (0.0.14)
@@ -34,7 +35,8 @@ GEM
       rinku (~> 1.7)
       sanitize (~> 2.0)
     i18n (0.6.5)
-    mime-types (1.25)
+    mercenary (0.2.0)
+    mime-types (1.25.1)
     mini_portile (0.5.1)
     minitest (4.7.5)
     multi_json (1.8.1)
@@ -54,7 +56,7 @@ GEM
       nokogiri (>= 1.4.4)
     thread_safe (0.1.3)
       atomic
-    typhoeus (0.6.5)
+    typhoeus (0.6.6)
       ethon (~> 0.6.1)
     tzinfo (0.3.38)
 

data/README.md

@@ -22,6 +22,8 @@ Or install it yourself as:
 
 ## Usage
 
+### In a script
+
 Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on
 your output folder; then `run` it. Here's a simple example:
 
@@ -52,6 +54,19 @@ end
 HTML::Proofer.new("./out").run
 ```
 
+### Usage on the command-line
+
+You'll get a new program called `htmlproof` with this gem. Jawesome!
+
+Use it like you'd expect to:
+
+``` bash
+htmlproof run ./out --swap wow:cow,mow:doh --ext .html.erb --ignore www.github.com
+```
+
+Note: since `swap` is a bit special, you'll pass in a pair of `RegEx:String` values.
+`htmlproof` will figure out what you mean.
+
 ## 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:
@@ -65,6 +80,12 @@ task :test do
 end
 ```
 
+Don't have or want a `Rakefile`? You _could_ also do something like the following:
+
+```bash
+htmlproof ./_site
+```
+
 ## What's Tested?
 
 * Whether all your images have alt tags
@@ -75,7 +96,6 @@ end
 
 ## Configuration 
 
-
 The `HTML::Proofer` constructor takes an optional hash of additional options:
 
 * `:ext`: the extension (including the `.`) of your HTML files (default: `.html`)

data/Rakefile

@@ -5,4 +5,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => :spec

data/bin/htmlproof

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+STDOUT.sync = true
+
+require './lib/html/proofer'
+require 'mercenary'
+
+Mercenary.program(:htmlproof) do |p|
+  # p.version HTML::Proofer::VERSION
+  p.description "Test your rendered HTML files to make sure they're accurate."
+  p.syntax 'htmlproof run PATH [options]'
+
+  p.command(:run) do |c|
+    c.syntax "htmlproof run PATH"
+    c.description "Runs the HTML-Proofer suite on the files in PATH"
+
+    c.option 'ext', '--ext EXT', String, 'The extension of your HTML files (default: `.html`)'
+    c.option 'swap', '--swap regex:string,[regex:string,...]', Array, 'Array containing key-value pairs of `RegExp:String`. It transforms links that match `RegExp` into `String`'
+    c.option 'ignore', '--ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore (default: `mailto`)'
+
+    c.action do |args, opts|
+      raise "`run` requires a PATH indicating a directory of files to check" if args.empty?
+      options = {}
+      options[:ext] = opts["ext"] unless opts["ext"].nil?
+      unless opts["swap"].nil?
+        options[:href_swap] = {}
+        opts["swap"].each do |s|
+          pair = s.split(":")
+          options[:href_swap][%r{#{pair[0]}}] = pair[1]
+        end
+      end
+      options[:href_ignore] = opts["ignore"] unless opts["ignore"].nil?
+
+      HTML::Proofer.new(args[0], options).run
+    end
+  end
+
+  p.default_command(:run)
+end

data/html-proofer.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/html/proofer/version", __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require 'html/proofer/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "html-proofer"
@@ -14,7 +15,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "nokogiri",        "1.6.0"
+  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"
 

data/lib/html/proofer.rb

@@ -1,65 +1,53 @@
 require 'nokogiri'
-require 'find'
-require 'html/proofer/checkable'
-require 'html/proofer/checks'
+require File.dirname(__FILE__) + '/proofer/checkable'
+require File.dirname(__FILE__) + '/proofer/checks'
 
 module HTML
   class Proofer
     def initialize(src, opts={})
       @srcDir = src
       @options = {:ext => ".html"}.merge(opts)
-      @failedTests = []
     end
 
     def run
-      get_checks.each do |klass|
-        puts "Running #{klass.name.split(/:/).pop()} check... \n\n"
+      total_files = 0
+      failed_tests = []
 
-        Find.find(@srcDir) do |path|
-          if File.extname(path) == @options[:ext]
-            html = HTML::Proofer.create_nokogiri(path)
-            check = klass.new(@srcDir, path, html, @options)
-            check.run
-            check.hydra.run
-            self.print_issues(klass, check.issues)
-          end
+      puts "Running #{get_checks} checks on #{@srcDir}... \n\n"
+
+      Dir.glob("#{@srcDir}/**/*#{@options[:ext]}") 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
         end
       end
 
-      if @failedTests.empty?
-        puts "Tests executed successfully.".green
+      puts "Ran on #{total_files} files!"
+
+      if failed_tests.empty?
+        puts "HTML-Proofer finished successfully.".green
         exit 0
       else
-        # make the hash default to 0 so that += will work correctly
-        count = Hash.new(0)
-
-        # iterate over the array, counting duplicate entries
-        @failedTests.each do |v|
-          count[v] += 1
+        failed_tests.each do |issue|
+          $stderr.puts issue + "\n\n"
         end
 
-        count.each do |k, v|
-          $stderr.puts "#{k} failed #{v} times"
-        end
-        raise "Tests ran, but found failures!"
+        raise "HTML-Proofer found #{failed_tests.length} failures!"
       end
     end
 
     def self.create_nokogiri(path)
-      path << "/index.html" if File.directory? path #support for Jekyll-style links
+      path << "/index.html" if File.directory? path # support for Jekyll-style links
       Nokogiri::HTML(File.read(path))
     end
 
     def get_checks
       HTML::Proofer::Checks::Check.subclasses
     end
-
-    def print_issues(klass, issues)
-      return if issues.empty?
-      @failedTests.push klass
-      issues.each do |issue|
-        $stderr.puts issue + "\n\n"
-      end
-    end
   end
 end

data/lib/html/proofer/check.rb

@@ -18,6 +18,7 @@ class HTML::Proofer::Checks
       @html   = html
       @options = opts
       @issues = []
+      @checked_urls = {}
 
       @hydra = Typhoeus::Hydra.hydra
       @additional_href_ignores = @options[:href_ignore] || []
@@ -36,10 +37,11 @@ class HTML::Proofer::Checks
     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?
-          # no op
+          @checked_urls[href] = true
         elsif response.timed_out?
           self.add_issue(issue_text + " got a time out")
         elsif response.code == 0
@@ -57,6 +59,8 @@ class HTML::Proofer::Checks
             self.add_issue("#{issue_text} HTTP request failed: #{response_code}")
           end
         end
+
+        @checked_urls[href] = false unless response.success?
       end
       hydra.queue(request)
     end

data/lib/html/proofer/checkable.rb

@@ -10,6 +10,7 @@ module HTML
         @id = obj['id']
         @data_ignore_proofer = obj['data-proofer-ignore']
         @check = check
+        @checked_paths = {}
 
         if @href && @check.options[:href_swap]
           @check.options[:href_swap].each do |link, replace|
@@ -73,7 +74,6 @@ module HTML
       end
 
       def file_path
-
         return if path.nil?
 
         if path =~ /^\// #path relative to root
@@ -94,7 +94,8 @@ module HTML
 
       # checks if a file exists relative to the current pwd
       def exists?
-        File.exist? absolute_path
+        return @checked_paths[absolute_path] if @checked_paths.has_key? absolute_path
+        @checked_paths[absolute_path] = File.exist? absolute_path
       end
 
       def absolute_path

data/lib/html/proofer/checks.rb

@@ -1,9 +1,9 @@
 module HTML
   class Proofer
     class Checks
-      require 'html/proofer/check'
-      require 'html/proofer/checks/images'
-      require 'html/proofer/checks/links'
+      require File.dirname(__FILE__) + '/check'
+      require File.dirname(__FILE__) + '/checks/images'
+      require File.dirname(__FILE__) + '/checks/links'
     end
   end
 end

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

@@ -23,7 +23,6 @@ class Image < ::HTML::Proofer::Checkable
 end
 
 class Images < ::HTML::Proofer::Checks::Check
-
   def run
     @html.css('img').each do |img|
 

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

@@ -40,8 +40,12 @@ class Links < ::HTML::Proofer::Checks::Check
         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?
-          target_html = HTML::Proofer.create_nokogiri link.absolute_path
-          self.add_issue "linking to #{link.href}, but #{link.hash} does not exist" unless hash_check target_html, link.hash
+          unless link.exists?
+            self.add_issue "trying to find hash of #{link.href}, but #{link.absolute_path} does not exist"
+          else
+            target_html = HTML::Proofer.create_nokogiri link.absolute_path
+            self.add_issue "linking to #{link.href}, but #{link.hash} does not exist" unless hash_check target_html, link.hash
+          end
         end
       end
     end

data/lib/html/proofer/version.rb

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

data/spec/html/proofer/fixtures/linkTranslatedViaHrefSwap.html

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+
+<a href="/articles/linkToFolder">A real file, but the href should change!</a>
+
+</body>
+
+</html>

data/spec/html/proofer/links_spec.rb

@@ -87,4 +87,11 @@ describe "Links tests" do
     @linkCheck.run
     @linkCheck.issues[0].should eq(nil)
   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)
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'bundler/setup'
-require_relative "../lib/html-proofer"
+require_relative "../lib/html/proofer"
 
 require File.expand_path('../../lib/html/proofer/version.rb', __FILE__)
 

metadata

@@ -1,27 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
@@ -108,8 +122,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/htmlproof
 - html-proofer.gemspec
-- lib/html-proofer.rb
 - lib/html/proofer.rb
 - lib/html/proofer/check.rb
 - lib/html/proofer/checkable.rb
@@ -132,6 +146,7 @@ files:
 - spec/html/proofer/fixtures/ignorableLinks.html
 - spec/html/proofer/fixtures/index.html
 - spec/html/proofer/fixtures/linkToFolder.html
+- spec/html/proofer/fixtures/linkTranslatedViaHrefSwap.html
 - spec/html/proofer/fixtures/linkWithHttps.html
 - spec/html/proofer/fixtures/linkWithRedirect.html
 - spec/html/proofer/fixtures/missingImageAlt.html
@@ -190,6 +205,7 @@ test_files:
 - spec/html/proofer/fixtures/ignorableLinks.html
 - spec/html/proofer/fixtures/index.html
 - spec/html/proofer/fixtures/linkToFolder.html
+- spec/html/proofer/fixtures/linkTranslatedViaHrefSwap.html
 - spec/html/proofer/fixtures/linkWithHttps.html
 - spec/html/proofer/fixtures/linkWithRedirect.html
 - spec/html/proofer/fixtures/missingImageAlt.html

data/lib/html-proofer.rb

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