capybara-validate_html5 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abeb0e5a54618097048f3476bc49bf454afe6bff7ac5ccb56ac46bdf4ec0ea12
-  data.tar.gz: a2f0356a2d583be4d9c985803bc809df7dd4e8ad71b9c96a524d037f756ae346
+  metadata.gz: a9d1ef7637dc132bd66e5f979be8d9ef5020f8da97cfa24347a00e3888ed12a0
+  data.tar.gz: 5121a990aeda11d5cbc89651d00b1a57eda970c9f8670bf82f49d41bb20f30ae
 SHA512:
-  metadata.gz: c93d81860de762973748165f13192543cc546ec3f0d5d2ed07bf60e70ac429675f0f1a4cff4bdc625d126806640f6221510f85c2f320ea2533ea676b9b8dcbbb
-  data.tar.gz: d612c465456403978375ec3059e0fdb47df0a7658f149f3a0f9777d3340cfe1a88bd16f000fb8bdf176adabeb765a068330f481aed6af5bc7f6bcd4112189579
+  metadata.gz: e331ed3df13debeaf4e3131490ebb1e35508edd5db23da0d103164873f1c0bdebffa3a527cb0e990ed4f4ff3736cb62010ea6b060296117c0b7d8068e77ce233
+  data.tar.gz: 1d33645a992b0b6ff288909bcbc9ad7cfe2a867b4e585c65b212266de8e07cb71b4c58d5ed7ba1c2941f773b1f36e27bcc413796c711c5d986e0787acc84d81d

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 1.1.0 (2022-05-26)
+
+* Make error output more friendly, showing error message and HTML for each error (jeremyevans)
+
+* Require html5 validation by default, use capybara/optionally_validate_html5 for previous behavior (jeremyevans)
+
+* Work with capybara 3.37.0 (jeremyevans)
+
 === 1.0.0 (2022-03-07)
 
 * Initial Public Release

data/README.rdoc

@@ -5,7 +5,8 @@ fails if there are any HTML5 parse errors on the page.  This makes
 it easy to automatically test for HTML5 validity when running your
 normal capybara test suite.
 
-This only works for the rack-test driver.
+This only works for the rack-test driver, and only works when using
+minitest-global_expectations for testing.
 
 = Installation
 
@@ -19,8 +20,9 @@ Source code is available on GitHub at https://github.com/jeremyevans/capybara-va
 
   require 'capybara'
   require 'capybara/validate_html5'
+  require 'minitest/global_expectations'
 
-  describe Capybara::RestoreState do
+  describe 'capybara-validate_html5' do
     include Rack::Test::Methods
     include Capybara::DSL
 

data/lib/capybara/optionally_validate_html5.rb

@@ -0,0 +1,12 @@
+require 'capybara'
+
+if Capybara.respond_to?(:use_html5_parsing) && defined?(Nokogiri::HTML5)
+  require_relative 'validate_html5'
+else
+  module Capybara::DSL
+    # If HTML5 validation isn't supported, make this a no-op.
+    def skip_html_validation
+      yield
+    end
+  end
+end

data/lib/capybara/validate_html5.rb

@@ -1,63 +1,68 @@
 require 'capybara'
 
 module Capybara
-  if respond_to?(:use_html5_parsing) && defined?(Nokogiri::HTML5)
-    self.use_html5_parsing = true
-
-    require 'capybara/rack_test/browser'
-    require 'capybara/dsl'
-    require 'minitest'
-
-    module RackTest::ValidateDom
-      # Skip HTML validation inside the block.
-      def skip_html_validation
-        skip = @skip_html_validation
-        @skip_html_validation = true
-        yield
-      ensure
-        @skip_html_validation = skip
-      end
+  unless Capybara.respond_to?(:use_html5_parsing) && defined?(Nokogiri::HTML5)
+    raise LoadError, "capybara-validate_html5 cannot be used as Capybara or Nokogiri doesn't support HTML5 parsing (require capybara/optionally_validate_html5 to make validation optional)"
+  end
 
-      # If loading the DOM for the first time and not skipping
-      # HTML validation, validate the HTML and expect no errors.
-      def dom
-        unless @dom || @skip_html_validation
-          errors = Nokogiri::HTML5(html, max_errors: 10).errors
-          unless errors.empty?
-            first_error_line = errors.first.line
-            begin_line = first_error_line - 3
-            end_line = first_error_line + 3
-            begin_line = 0 if begin_line < 0
-            called_from = caller_locations.detect do |loc|
-              loc.path !~ %r{lib/(capybara|nokogiri|minitest)}
-            end
-            errors.must_be_empty(<<END_MSG)
-invalid HTML on page returned for #{last_request.path}, called from #{called_from.path}:#{called_from.lineno}
+  self.use_html5_parsing = true
+
+  require 'capybara/rack_test/browser'
+  require 'capybara/dsl'
+  require 'minitest'
 
-#{html.split("\n")[begin_line..end_line].join("\n")}
+  module RackTest::ValidateDom
+    # Skip HTML validation inside the block.
+    def skip_html_validation
+      skip = @skip_html_validation
+      @skip_html_validation = true
+      yield
+    ensure
+      @skip_html_validation = skip
+    end
+
+    # If loading the DOM for the first time and not skipping
+    # HTML validation, validate the HTML and expect no errors.
+    def dom
+      unless @dom || @skip_html_validation
+        errors = Nokogiri::HTML5(html, max_errors: 10).errors
+        unless errors.empty?
+          called_from = caller_locations.detect do |loc|
+            loc.path !~ %r{lib/(capybara|nokogiri|minitest)}
+          end
+          html_lines = html.split("\n").map.with_index{|line, i| "#{sprintf("%6i", i+1)}: #{line}"}
+          error_info = String.new
+          error_info << (<<END_MSG)
+invalid HTML on page returned for #{last_request.path}, called from #{called_from.path}:#{called_from.lineno}
 
 END_MSG
+
+          errors.each do |error|
+            error_line = error.line
+            begin_line = error_line - 3
+            end_line = error_line + 3
+            begin_line = 0 if begin_line < 0
+            error_info << error.to_s << "\n" << html_lines[begin_line..end_line].join("\n") << "\n\n"
           end
+
+          errors.size.must_equal(0, error_info)
         end
-        super
       end
+      super
     end
 
-    RackTest::Browser.prepend(RackTest::ValidateDom)
-
-    module DSL
-      # Skip HTML validation inside the block.
-      def skip_html_validation(&block)
-        page.driver.browser.skip_html_validation(&block)
-      end
+    # Skip HTML validation during base_href calculations.
+    def base_href
+      skip_html_validation{super}
     end
-  else
-    module DSL
-      # If HTML5 validation isn't supported, make this
-      # a no-op.
-      def skip_html_validation(&block)
-        yield
-      end
+  end
+
+  RackTest::Browser.prepend(RackTest::ValidateDom)
+
+  module DSL
+    # Skip HTML validation inside the block.
+    def skip_html_validation(&block)
+      page.driver.browser.skip_html_validation(&block)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-validate_html5
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -82,6 +82,7 @@ files:
 - CHANGELOG
 - MIT-LICENSE
 - README.rdoc
+- lib/capybara/optionally_validate_html5.rb
 - lib/capybara/validate_html5.rb
 homepage: http://github.com/jeremyevans/capybara-validate_html5
 licenses: