html-proofer 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec0386b90eb4e6cd4488cc9c05a51f9bb4618b9
-  data.tar.gz: 131403625ac57dc2efbae4799f6925151457f0d5
+  metadata.gz: f2eb21756ab1eb24e38b51ada6d481b1dbc42eb8
+  data.tar.gz: bb779ed45d42bb8c9e7824cb66bcdd33f027c2ee
 SHA512:
-  metadata.gz: 8574ae57e7f490f393d0031f054d3f00b5e2ab8a530bfa9bf4188328186c29aefc4508db03422a520febdd15149a13aadf8f5f6d5a910ae6ea6856962085c8f3
-  data.tar.gz: 56ebf1b4e835f97aca351f4c76eef0000198f09b555f155ba1510faf719b0c423cae7377d411478276c431342ae5854fcd77afe12952b89f4631c61e15ef8df1
+  metadata.gz: 3dd53810b0e3ae1b9760ced7d748100ab5ff56ed9b2b5f9770ea67960653b3a00d199a82f3a92c86c43054c3ec21191f82d9a860be389abce615aaf71b465425
+  data.tar.gz: 1225ae4c9a19292b05017409233dd8e8d1c0bcc5761038a8b40f62bebcc5926073e185ff7a4d4de205a4ffd53886d91481adaba54a57c13eba0086eeac404aba

data/README.md

@@ -63,7 +63,7 @@ You'll get a new program called `htmlproof` with this gem. Terrific!
 Use it like you'd expect to:
 
 ``` bash
-htmlproof run ./out --swap wow:cow,mow:doh --ext .html.erb --ignore www.github.com
+htmlproof ./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.
@@ -139,6 +139,8 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `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` |
 
+### Configuring Typhoeus
+
 You can also pass in any of Typhoeus' options for the external link check. For example:
 
 ``` ruby
@@ -147,6 +149,18 @@ HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost =>
 
 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.
 
+### Configuring Parallel
+
+[Parallel](https://github.com/grosser/parallel) is being used to speed things up a bit. You can pass in any of its options with the options "namespace" `:parallel`. For example:
+
+``` ruby
+HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost => 2, :parallel => { :in_processes => 3} })
+```
+
+`:in_processes => 3` will be passed into Parallel as a configuration option.
+
+### Array of links
+
 Instead of a directory as the first argument, you can also pass in an array of links:
 
 ``` ruby

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.3.3"
+  gem.version       = "1.4.0"
   gem.authors       = ["Garen Torikian"]
   gem.email         = ["gjtorikian@gmail.com"]
   gem.description   = %q{Test your rendered HTML files to make sure they're accurate.}
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "colored",         "~> 1.2"
   gem.add_dependency "typhoeus",        "~> 0.6.7"
   gem.add_dependency "yell",            "~> 2.0"
+  gem.add_dependency "parallel",        "~> 1.3"
 
   gem.add_development_dependency "redcarpet"
   gem.add_development_dependency "rspec", "~> 2.13.0"

data/lib/html/proofer.rb

@@ -1,5 +1,6 @@
 require 'nokogiri'
 require 'yell'
+require 'parallel'
 
 begin
   require "awesome_print"
@@ -24,6 +25,8 @@ module HTML
   class Proofer
     include Yell::Loggable
 
+    attr_reader :options, :typhoeus_opts, :parallel_opts
+
     def initialize(src, opts={})
       @src = src
 
@@ -43,6 +46,10 @@ module HTML
         :followlocation => true
       }
 
+      # fall back to parallel defaults
+      @parallel_opts = opts[:parallel] || {}
+      opts.delete(:parallel)
+
       # Typhoeus won't let you pass in any non-Typhoeus option; if the option is not
       # a proofer_opt, it must be for Typhoeus
       opts.keys.each do |key|
@@ -63,27 +70,32 @@ module HTML
 
     def run
       unless @src.is_a? Array
-        total_files = 0
         external_urls = {}
 
         logger.info HTML::colorize :white, "Running #{get_checks} checks on #{@src} on *#{@options[:ext]}... \n\n"
 
-        files.each do |path|
-          total_files += 1
+        results = Parallel.map(files, @parallel_opts) do |path|
           html = HTML::Proofer.create_nokogiri(path)
+          result = {:external_urls => {}, :failed_tests => []}
 
           get_checks.each do |klass|
             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)
-            @failed_tests.concat(check.issues) if check.issues.length > 0
+            result[:external_urls].merge!(check.external_urls)
+            result[:failed_tests].concat(check.issues) if check.issues.length > 0
           end
+          result
+        end
+
+        results.each do |item|
+          external_urls.merge!(item[:external_urls])
+          @failed_tests.concat(item[:failed_tests])
         end
 
         external_link_checker(external_urls) unless @options[:disable_external]
 
-        logger.info HTML::colorize :green, "Ran on #{total_files} files!\n\n"
+        logger.info HTML::colorize :green, "Ran on #{files.length} files!\n\n"
       else
         external_urls = Hash[*@src.map{ |s| [s, nil] }.flatten]
         external_link_checker(external_urls) unless @options[:disable_external]

data/lib/html/proofer/checkable.rb

@@ -36,9 +36,11 @@ module HTML
       end
 
       def parts
-        URI::Parser.new(:ESCAPED => '\%|\|').parse url
+        return @parts_cached if defined?(@parts_cached)
+
+        @parts_cached = URI::Parser.new(:ESCAPED => '\%|\|').parse url
       rescue URI::Error
-        nil
+        @parts_cached = nil
       end
 
       def path

data/spec/html/proofer_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 describe HTML::Proofer do
+
   describe "#failed_tests" do
     it "is a list of the formatted errors" do
       brokenLinkInternalFilepath = "#{FIXTURES_DIR}/links/brokenLinkInternal.html"
@@ -9,6 +10,7 @@ describe HTML::Proofer do
       proofer.failed_tests.should eq(["\e[34mspec/html/proofer/fixtures/links/brokenLinkInternal.html\e[0m: internally linking to ./notreal.html, which does not exist", "\e[34mspec/html/proofer/fixtures/links/brokenLinkInternal.html\e[0m: internally linking to ./missingImageAlt.html, which does not exist"])
     end
   end
+
   describe "#files" do
     it "works for directory that ends with .html" do
       folder = "#{FIXTURES_DIR}/links/_site/folder.html"
@@ -16,4 +18,21 @@ describe HTML::Proofer do
       proofer.files.should == ["#{folder}/index.html"]
     end
   end
+
+  describe "#options" do
+    it "strips out undesired Typhoeus options" do
+      folder = "#{FIXTURES_DIR}/links/_site/folder.html"
+      proofer = HTML::Proofer.new folder, :verbose => true
+      proofer.options[:verbose].should == true
+      proofer.typhoeus_opts[:verbose].should == nil
+    end
+
+    it "takes options for Parallel" do
+      folder = "#{FIXTURES_DIR}/links/_site/folder.html"
+      proofer = HTML::Proofer.new folder, :parallel => { :in_processes => 3 }
+      proofer.parallel_opts[:in_processes].should == 3
+      proofer.typhoeus_opts[:in_processes].should == nil
+      proofer.options[:parallel].should == nil
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2014-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement