capybara-validate_html5 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abeb0e5a54618097048f3476bc49bf454afe6bff7ac5ccb56ac46bdf4ec0ea12
-  data.tar.gz: a2f0356a2d583be4d9c985803bc809df7dd4e8ad71b9c96a524d037f756ae346
+  metadata.gz: 0f32ed1925ec14c9311dd217c9b7d0639d79fef0040d5b6f21393f5553267ec3
+  data.tar.gz: a39dab6f833867d06d5cac1260693588885788f3de193234b1789a71121d737e
 SHA512:
-  metadata.gz: c93d81860de762973748165f13192543cc546ec3f0d5d2ed07bf60e70ac429675f0f1a4cff4bdc625d126806640f6221510f85c2f320ea2533ea676b9b8dcbbb
-  data.tar.gz: d612c465456403978375ec3059e0fdb47df0a7658f149f3a0f9777d3340cfe1a88bd16f000fb8bdf176adabeb765a068330f481aed6af5bc7f6bcd4112189579
+  metadata.gz: cf51d9e611941e92ab1c5aeca7b9d70e660e39a72ff07d95d8fe8389160095141fa8a67d6ef5493d455216c539e5745dbf851d3558fe47abdf32d96fa4f7230f
+  data.tar.gz: 67ceffa7c755f7460c0806675cae0bd72176100ca8b9abd6842eabe71ef091dd4b3876bdd8fd4119e9b84148d3401091d1d0ab9eb75b144d8c4b07747b4edf39

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 2.0.0 (2024-12-31)
+
+* Remove runtime dependency on minitest and minitest-global_expectations (jeremyevans)
+
+=== 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/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2022 Jeremy Evans
+Copyright (c) 2022-2024 Jeremy Evans
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/README.rdoc

@@ -1,6 +1,6 @@
 = capybara-validate_html5
 
-capybara-validate_html5 validates the HTML5 for each page accessed, and
+capybara-validate_html5 validates the HTML5 for each page parsed, and
 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.
@@ -17,10 +17,9 @@ Source code is available on GitHub at https://github.com/jeremyevans/capybara-va
 
 = Examples
 
-  require 'capybara'
   require 'capybara/validate_html5'
 
-  describe Capybara::RestoreState do
+  describe 'capybara-validate_html5' do
     include Rack::Test::Methods
     include Capybara::DSL
 
@@ -29,13 +28,19 @@ Source code is available on GitHub at https://github.com/jeremyevans/capybara-va
     end
 
     it "should allow restoring of state" do
-      visit '/' # validates HTML, fails spec if not valid
+      visit '/' # No validation on retrieval
+      page.body # No validation on body access
 
+      page.all("a") # Attempt to parse body, validates HTML, raises exception if not valid
+      page.all("a") # No validation, as same body already parsed
+
+      visit '/page1'
+      click_link 'Go Somewhere' # Attempt to parse body, validates HTML, raises exception if not valid
+
+      visit '/page2'
       skip_html_validation do
-        click_button 'Submit' # doesn't validate resulting HTML
+        click_button 'Submit' # No validation, as it was explicitly skipped
       end
-
-      click_link 'Go Somewhere' # validates HTML, fails spec if not valid
     end
   end
 

data/lib/capybara/optionally_validate_html5.rb

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

data/lib/capybara/validate_html5.rb

@@ -1,63 +1,73 @@
 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
+  # Exception class raised for HTML5 validations
+  class HTML5ValidationError < StandardError
+  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}
+  # :nocov:
+  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
+  # :nocov:
 
-#{html.split("\n")[begin_line..end_line].join("\n")}
+  self.use_html5_parsing = true
+
+  require 'capybara/rack_test/browser'
+  require 'capybara/dsl'
+
+  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
+
+          raise HTML5ValidationError, "#{errors.size} HTML5 validation errors: #{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,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara-validate_html5
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -45,7 +44,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,7 +58,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |
-  capybara-validate validates the HTML5 for each page accessed, and
+  capybara-validate validates the HTML5 for each page parsed, and
   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.
@@ -82,6 +81,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:
@@ -90,13 +90,12 @@ metadata:
   bug_tracker_uri: https://github.com/jeremyevans/capybara-validate_html5/issues
   changelog_uri: https://github.com/jeremyevans/capybara-validate_html5/blob/master/CHANGELOG
   source_code_uri: https://github.com/jeremyevans/capybara-validate_html5
-post_install_message: 
 rdoc_options:
 - "--quiet"
 - "--line-numbers"
 - "--inline-source"
 - "--title"
-- 'capybara-validate: Validate HTML5 for each page accessed'
+- 'capybara-validate: Validate HTML5 for each page parsed'
 - "--main"
 - README.rdoc
 require_paths:
@@ -112,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Validate HTML5 for each page accessed
+summary: Validate HTML5 for each page parsed
 test_files: []