html-proofer 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2378653066f706946320a842961fa24145a30c6c
-  data.tar.gz: d5f9af8f26f706d8749c7703aced6f00282b2fd1
+  metadata.gz: 8328f696789f830910e2bee17b2b015e8ffc0b0d
+  data.tar.gz: f051884d9787841d70dfdaf2ebedc5bb7818a6e2
 SHA512:
-  metadata.gz: 33ddc59a5868f717d5f1a57ae259d0adac9401786952bbc5df502ce8dd89ed29cf52969df2df8dbc57325d1800eaa755fd629fa4e093e4c5464672c60b6ea2f0
-  data.tar.gz: fe325d831dfd59fc5d48ab7eace5514c0ba6877151a84341183cb7b8a3949a7b4ff3a8500a03e4f201669c9e8c19fca0c77d742b0232e3e2617f178d17acf7ff
+  metadata.gz: cf0bfd4a6060c0eebe58be4caad40cbada074241ed378ced25236f52e594b1ff1f1d528c4bb757fac11fe4bb3a68dce072950ccbe5eb965652179660fda19285
+  data.tar.gz: 53fe8b4b33e7d6507da659f18e54279c85bf741d9bb84439430147584ac1928ff085b31cd61576313098e1e383b216bdff0f844fb9e4fb0f3156c11176a2195a

data/README.md

@@ -140,6 +140,7 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |
 | `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored. | `[]` |
 | `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
+| `file_ignore` | An array of Strings or RegExps containing file paths that are safe to ignore. | `[]` |
 | `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` |
 | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |

data/bin/htmlproof

@@ -18,8 +18,9 @@ Mercenary.program(:htmlproof) do |p|
   p.option 'favicon', '--favicon', 'Enables the favicon checker (default: `false`).'
   p.option 'as-links', '--as-links', 'Assumes that `PATH` is a comma-separated array of links to check.'
   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 'href_ignore', '--href_ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored.'
-  p.option 'alt_ignore', '--alt_ignore image1,[image2,...]', Array, 'Array of Strings containing `img`s whose missing `alt` tags are safe to ignore'
+  p.option 'href_ignore', '--href_ignore link1,[link2,...]', Array, 'Array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored.'
+  p.option 'alt_ignore', '--alt_ignore image1,[image2,...]', Array, 'Array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore'
+  p.option 'file_ignore', '--file_ignore file1,[file2,...]', Array, 'Array of Strings or RegExps containing file paths that are safe to ignore'
   p.option 'disable_external', '--disable_external', 'Disables the external link checker (default: `false`)'
   p.option 'only_4xx', '--only_4xx', 'Only reports errors for links that fall within the 4x status code range.'
   p.option 'verbose', '--verbose', 'Enables more verbose logging.'
@@ -43,6 +44,7 @@ Mercenary.program(:htmlproof) do |p|
 
     options[:href_ignore] = opts["href_ignore"] unless opts["href_ignore"].nil?
     options[:alt_ignore] = opts["alt_ignore"] unless opts["alt_ignore"].nil?
+    options[:file_ignore] = opts["file_ignore"] unless opts["file_ignore"].nil?
     options[:disable_external] = opts["disable_external"] unless opts["disable_external"].nil?
     options[:only_4xx] = opts["only_4xx"] unless opts["only_4xx"].nil?
     options[:favicon] = opts["favicon"] unless opts["favicon"].nil?

data/lib/html/proofer.rb

@@ -37,6 +37,7 @@ module HTML
         :favicon => false,
         :href_swap => [],
         :href_ignore => [],
+        :file_ignore => [],
         :check_external_hash => false,
         :alt_ignore => [],
         :disable_external => false,
@@ -220,14 +221,27 @@ module HTML
     def files
       if File.directory? @src
         pattern = File.join @src, "**", "*#{@options[:ext]}"
-        Dir.glob(pattern).select { |fn| File.file? fn }
+        files = Dir.glob(pattern).select { |fn| File.file? fn }
+        files.reject { |f| ignore_file?(f) }
       elsif File.extname(@src) == @options[:ext]
-        [@src]
+        [@src].reject { |f| ignore_file?(f) }
       else
         []
       end
     end
 
+    def ignore_file?(file)
+      @options[:file_ignore].each do |pattern|
+        if pattern.is_a? String
+          return pattern == file
+        elsif pattern.is_a? Regexp
+          return pattern =~ file
+        end
+      end
+
+      false
+    end
+
     def self.create_nokogiri(path)
       content = File.open(path).read
       Nokogiri::HTML(content)

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = "1.5.4"
+    VERSION = "1.6.0"
   end
 end

data/spec/html/proofer_spec.rb

@@ -75,5 +75,28 @@ describe HTML::Proofer do
       """.strip)
       end
     end
+
+    describe "file ignores" do
+      it "knows how to ignore a file by string" do
+        options = { :file_ignore => ["#{FIXTURES_DIR}/links/brokenHashInternal.html"] }
+        brokenHashInternalFilepath = "#{FIXTURES_DIR}/links/brokenHashInternal.html"
+        proofer = make_proofer(brokenHashInternalFilepath, options)
+        expect(proofer.failed_tests).to eq []
+      end
+
+      it "knows how to ignore a file by regexp" do
+        options = { :file_ignore => [/brokenHash/] }
+        brokenHashInternalFilepath = "#{FIXTURES_DIR}/links/brokenHashInternal.html"
+        proofer = make_proofer(brokenHashInternalFilepath, options)
+        expect(proofer.failed_tests).to eq []
+      end
+
+      it "knows how to ignore a directory by regexp" do
+        options = { :file_ignore => [/\S\.html/] }
+        linksDir = "#{FIXTURES_DIR}/links"
+        proofer = make_proofer(linksDir, options)
+        expect(proofer.failed_tests).to eq []
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary