html-proofer 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e94fed7b3cb30e272c5de25511ad9604e2a9663
-  data.tar.gz: d2ba44ef2943e993d69906089e374ae51013ff4b
+  metadata.gz: 1aa472890a7ddb766fee3cbe2753fb10debf3295
+  data.tar.gz: 8c3e21ca0c933f9f907603e64449db6e9ddf2906
 SHA512:
-  metadata.gz: 9f65536fcc74006b51ca34ecc77b048ea59608a2a055c4961afaa086d92c3fe09cc2056de5b7d2a5546f37ec0d6586bec29d1fd7fd05607aaaae3c777cf60172
-  data.tar.gz: ca131c1f0a7d06da44a40a7e714ece99821102153c158f130d909d226a86347ce10745d87b62954cdf71657188459fffef8b7410a949a5134b0ee9236ead3ec9
+  metadata.gz: fb1619b0ea97493a352a9fe1456aee45ce0558d7fd15140eb9e3c8f3599c795fba5c75e35c8ab224000bca3712beddf6220cd0f705a723bc047a66367943c142
+  data.tar.gz: 65a27bd59091f127e0b89b0b2d1328bb5bb52dbe2e88bb3deea039c6cbb4219ba29aa50cffc083a49fa4e67b54a463b456489a1520af12a4801443448def9ea2

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9
   - 2.0
   - 2.1
+  - 2.2
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/README.md

@@ -227,7 +227,7 @@ class MailToOctocat < ::HTML::Proofer::CheckRunner
 
   def run
     @html.css('a').each do |l|
-      link = OctocatLinkCheck.new l, "octocat_link", self
+      link = OctocatLinkCheck.new l, self
 
       if link.mailto? && link.octocat?
         return add_issue("Don't email the Octocat directly!")

data/html-proofer.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'mercenary',       '~> 0.3.2'
   gem.add_dependency 'nokogiri',        '~> 1.5'
   gem.add_dependency 'colored',         '~> 1.2'
-  gem.add_dependency 'typhoeus',        '~> 0.6.7'
+  gem.add_dependency 'typhoeus',        '~> 0.7'
   gem.add_dependency 'yell',            '~> 2.0'
   gem.add_dependency 'parallel',        '~> 1.3'
   gem.add_dependency 'addressable',     '~> 2.3'

data/lib/html/proofer/check_runner.rb

@@ -1,56 +1,60 @@
 # encoding: utf-8
 
-class HTML::Proofer
-
-  # Mostly handles issue management and collecting of external URLs.
-  class CheckRunner
-
-    attr_reader :issues, :src, :path, :options, :external_urls, :href_ignores, :alt_ignores
-
-    def initialize(src, path, html, opts={})
-      @src    = src
-      @path   = path
-      @html   = remove_ignored(html)
-      @options = opts
-      @issues = []
-      @href_ignores = @options[:href_ignore]
-      @alt_ignores = @options[:alt_ignore]
-      @external_urls = {}
-    end
+module HTML
+  class Proofer
+    # Mostly handles issue management and collecting of external URLs.
+    class CheckRunner
+
+      attr_reader :issues, :src, :path, :options, :typhoeus_opts, :hydra_opts, :parallel_opts, \
+                  :external_urls, :href_ignores, :alt_ignores
+
+      def initialize(src, path, html, options, typhoeus_opts, hydra_opts, parallel_opts)
+        @src    = src
+        @path   = path
+        @html   = remove_ignored(html)
+        @options = options
+        @typhoeus_opts = typhoeus_opts
+        @hydra_opts = hydra_opts
+        @parallel_opts = parallel_opts
+        @issues = []
+        @href_ignores = @options[:href_ignore]
+        @alt_ignores = @options[:alt_ignore]
+        @external_urls = {}
+      end
 
-    def run
-      fail NotImplementedError, 'HTML::Proofer::CheckRunner subclasses must implement #run'
-    end
+      def run
+        fail NotImplementedError, 'HTML::Proofer::CheckRunner subclasses must implement #run'
+      end
 
-    def add_issue(desc, line_number = nil, status = -1)
-      @issues << Issue.new(@path, desc, line_number, status)
-    end
+      def add_issue(desc, line_number = nil, status = -1)
+        @issues << Issue.new(@path, desc, line_number, status)
+      end
 
-    def add_to_external_urls(href)
-      if @external_urls[href]
-        @external_urls[href] << @path
-      else
-        @external_urls[href] = [@path]
+      def add_to_external_urls(href)
+        if @external_urls[href]
+          @external_urls[href] << @path
+        else
+          @external_urls[href] = [@path]
+        end
       end
-    end
 
-    def self.checks
-      classes = []
+      def self.checks
+        classes = []
 
-      ObjectSpace.each_object(Class) do |c|
-        next unless c.superclass == self
-        classes << c
-      end
+        ObjectSpace.each_object(Class) do |c|
+          next unless c.superclass == self
+          classes << c
+        end
 
-      classes
-    end
+        classes
+      end
 
-  private
+    private
 
-    def remove_ignored(html)
-      html.css('code, pre').each(&:unlink)
-      html
+      def remove_ignored(html)
+        html.css('code, pre').each(&:unlink)
+        html
+      end
     end
-
   end
 end

data/lib/html/proofer/checkable.rb

@@ -10,11 +10,9 @@ module HTML
 
       def initialize(obj, check)
         obj.attributes.each_pair do |attribute, value|
-          next if attribute == 'data-proofer-ignore' # TODO: not quite sure why this doesn't work
-          instance_variable_set("@#{attribute}".to_sym, value.value)
+          instance_variable_set("@#{attribute.tr('-', '_')}".to_sym, value.value)
         end
 
-        @data_ignore_proofer = obj['data-proofer-ignore']
         @content = obj.content
         @check = check
         @checked_paths = {}
@@ -45,7 +43,7 @@ module HTML
       end
 
       def path
-        CGI.unescape parts.path unless parts.nil?
+        Addressable::URI.unencode parts.path unless parts.nil?
       end
 
       def hash
@@ -66,7 +64,7 @@ module HTML
       end
 
       def ignore?
-        return true if @data_ignore_proofer
+        return true if @data_proofer_ignore
 
         case @type
         when 'FaviconCheckable'
@@ -140,7 +138,7 @@ module HTML
       end
 
       def follow_location?
-        @check.options[:typhoeus] && @check.options[:typhoeus][:followlocation]
+        @check.typhoeus_opts && @check.typhoeus_opts[:followlocation]
       end
 
       private

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

@@ -89,7 +89,7 @@ class LinkCheck < ::HTML::Proofer::CheckRunner
 
   def external_link_check(link)
     if !link.exists?
-      add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", l.line)
+      add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", link.line)
     else
       target_html = create_nokogiri link.absolute_path
       unless hash_check target_html, link.hash

data/lib/html/proofer/url_validator.rb

@@ -81,7 +81,7 @@ module HTML
         if response_code.between?(200, 299)
           check_hash_in_2xx_response(href, effective_url, response, filenames)
         elsif response.timed_out?
-          handle_timeout(filenames, response_code)
+          handle_timeout(href, filenames, response_code)
         elsif method == :head
           queue_request(:get, href, filenames)
         else
@@ -111,7 +111,7 @@ module HTML
         add_failed_tests filenames, "External link #{href} failed: #{effective_url} exists, but the hash '#{hash}' does not", response.code
       end
 
-      def handle_timeout
+      def handle_timeout(href, filenames, response_code)
         return if @options[:only_4xx]
         add_failed_tests filenames, "External link #{href} failed: got a time out", response_code
       end

data/lib/html/proofer/version.rb

@@ -1,5 +1,6 @@
 module HTML
   class Proofer
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end
+

data/lib/html/proofer.rb

@@ -21,7 +21,7 @@ module HTML
   class Proofer
     include Utils
 
-    attr_reader :options, :typhoeus_opts, :parallel_opts
+    attr_reader :options, :typhoeus_opts, :hydra_opts, :parallel_opts
 
     def initialize(src, opts = {})
       @src = src
@@ -117,7 +117,7 @@ module HTML
 
         checks.each do |klass|
           logger.log :debug, :yellow, "Checking #{klass.to_s.downcase} on #{path} ..."
-          check = Object.const_get(klass).new(@src, path, html, @options)
+          check = Object.const_get(klass).new(@src, path, html, @options, @typhoeus_opts, @hydra_opts, @parallel_opts)
           check.run
           result[:external_urls].merge!(check.external_urls)
           result[:failed_tests].concat(check.issues) if check.issues.length > 0

data/spec/html/proofer/fixtures/links/attributeWithDash.html

@@ -0,0 +1,8 @@
+<a
+  id="electriccars"
+  data-columns="3"
+  data-index-number="12314"
+  data-parent="cars"
+  href="https://www.github.com">
+Hullo
+</a>

data/spec/html/proofer/links_spec.rb

@@ -349,4 +349,10 @@ describe 'Links test' do
     proofer = run_proofer(fixture)
     expect(proofer.failed_tests.first).to match(/post.htm\?id=63009224 failed: 404 No error/)
   end
+
+  it 'does not complain for files with attributes containing dashes' do
+    fixture = "#{FIXTURES_DIR}/links/attributeWithDash.html"
+    proofer = run_proofer(fixture)
+    expect(proofer.failed_tests).to eq []
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.7
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.7
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: yell
   requirement: !ruby/object:Gem::Requirement
@@ -230,6 +230,7 @@ files:
 - spec/html/proofer/fixtures/images/workingDataURIImage.html
 - spec/html/proofer/fixtures/links/_site/folder.html/index.html
 - spec/html/proofer/fixtures/links/anchors_in_pre.html
+- spec/html/proofer/fixtures/links/attributeWithDash.html
 - spec/html/proofer/fixtures/links/blank_mailto_link.html
 - spec/html/proofer/fixtures/links/blank_tel_link.html
 - spec/html/proofer/fixtures/links/brokenHashExternal.html
@@ -382,6 +383,7 @@ test_files:
 - spec/html/proofer/fixtures/images/workingDataURIImage.html
 - spec/html/proofer/fixtures/links/_site/folder.html/index.html
 - spec/html/proofer/fixtures/links/anchors_in_pre.html
+- spec/html/proofer/fixtures/links/attributeWithDash.html
 - spec/html/proofer/fixtures/links/blank_mailto_link.html
 - spec/html/proofer/fixtures/links/blank_tel_link.html
 - spec/html/proofer/fixtures/links/brokenHashExternal.html