capybara-validate_html5 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d1ef7637dc132bd66e5f979be8d9ef5020f8da97cfa24347a00e3888ed12a0
-  data.tar.gz: 5121a990aeda11d5cbc89651d00b1a57eda970c9f8670bf82f49d41bb20f30ae
+  metadata.gz: f2b1d78fdef99821bc035edd33ace215061c0393e561ecf3033655a48d1e1f39
+  data.tar.gz: e30b30b5ec5522421a9f4a3fa340470a88437126ef259da24a4878ff1e3673d9
 SHA512:
-  metadata.gz: e331ed3df13debeaf4e3131490ebb1e35508edd5db23da0d103164873f1c0bdebffa3a527cb0e990ed4f4ff3736cb62010ea6b060296117c0b7d8068e77ce233
-  data.tar.gz: 1d33645a992b0b6ff288909bcbc9ad7cfe2a867b4e585c65b212266de8e07cb71b4c58d5ed7ba1c2941f773b1f36e27bcc413796c711c5d986e0787acc84d81d
+  metadata.gz: c0f524cebcb6b5802d807abe9bfc403920228876865904f76c63378bc5f275b2ec5a67c40c4ce887c776ab1059d17381c1cfa38f7e4cd3780683e12b18ce891e
+  data.tar.gz: 3e7a3154d57be416a2a0908111a1da3833570334097523db9e2d677bdda2966ee8f576fb559244c77a6aa59cb0d46ed5798cf73f9b171aa8026bd9e1cd2be4c7

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 2.1.0 (2025-05-06)
+
+* Support custom html validation via Capybara.custom_html_validation (jeremyevans)
+
+=== 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)

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,12 +1,11 @@
 = 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.
 
-This only works for the rack-test driver, and only works when using
-minitest-global_expectations for testing.
+This only works for the rack-test driver.
 
 = Installation
 
@@ -18,9 +17,7 @@ Source code is available on GitHub at https://github.com/jeremyevans/capybara-va
 
 = Examples
 
-  require 'capybara'
   require 'capybara/validate_html5'
-  require 'minitest/global_expectations'
 
   describe 'capybara-validate_html5' do
     include Rack::Test::Methods
@@ -31,16 +28,34 @@ 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
 
+= Custom HTML Validation
+
+You can perform your own custom validation of HTML elements, by calling
++Capybara.custom_html_validation+.  This will be passed the Nokogiri document
+and a block, and should call the block with any Nokogiri elements that are
+considered invalid:
+
+  Capybara.custom_html_validation do |doc, &block|
+    s = "*[required=true], *[required=false], input[checked=true], input[checked=false]"
+    doc.css(s).map(&block)
+  end
+
 = License
 
 MIT

data/lib/capybara/optionally_validate_html5.rb

@@ -2,6 +2,7 @@ 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.
@@ -9,4 +10,5 @@ else
       yield
     end
   end
+# :nocov:
 end

data/lib/capybara/validate_html5.rb

@@ -1,15 +1,20 @@
 require 'capybara'
 
 module Capybara
+  # Exception class raised for HTML5 validations
+  class HTML5ValidationError < StandardError
+  end
+
+  # :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:
 
   self.use_html5_parsing = true
 
   require 'capybara/rack_test/browser'
   require 'capybara/dsl'
-  require 'minitest'
 
   module RackTest::ValidateDom
     # Skip HTML validation inside the block.
@@ -25,7 +30,16 @@ module Capybara
     # HTML validation, validate the HTML and expect no errors.
     def dom
       unless @dom || @skip_html_validation
-        errors = Nokogiri::HTML5(html, max_errors: 10).errors
+        doc = Nokogiri::HTML5(html, max_errors: 10)
+        errors = doc.errors
+
+        if errors.empty?
+          custom_html_validation(doc) do |element|
+            errors << element
+            break if errors.length >= 10
+          end
+        end
+
         unless errors.empty?
           called_from = caller_locations.detect do |loc|
             loc.path !~ %r{lib/(capybara|nokogiri|minitest)}
@@ -45,7 +59,7 @@ END_MSG
             error_info << error.to_s << "\n" << html_lines[begin_line..end_line].join("\n") << "\n\n"
           end
 
-          errors.size.must_equal(0, error_info)
+          raise HTML5ValidationError, "#{errors.size} HTML5 validation errors: #{error_info}"
         end
       end
       super
@@ -55,6 +69,15 @@ END_MSG
     def base_href
       skip_html_validation{super}
     end
+
+    private
+
+    # Perform any custom HTML validation
+    def custom_html_validation(doc, &block)
+      # nothing by default
+    end
+    # Avoid method override warnings
+    alias custom_html_validation custom_html_validation
   end
 
   RackTest::Browser.prepend(RackTest::ValidateDom)
@@ -65,4 +88,16 @@ END_MSG
       page.driver.browser.skip_html_validation(&block)
     end
   end
+
+  # Define custom validation to use, in addition to standard HTML5 validation.
+  # This can allow you to detect and raise errors for issues that are not
+  # caught by Nokogiri's HTML5 validation.
+  def self.custom_html_validation(&block)
+    RackTest::ValidateDom.class_eval do
+      define_method(:custom_html_validation, &block)
+      alias_method(:custom_html_validation, :custom_html_validation)
+      private(:custom_html_validation)
+    end
+    nil
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara-validate_html5
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-26 00:00:00.000000000 Z
+date: 1980-01-02 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.
@@ -75,9 +74,9 @@ email: code@jeremyevans.net
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
 - CHANGELOG
 - MIT-LICENSE
+- README.rdoc
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -91,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:
@@ -113,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.7
 specification_version: 4
-summary: Validate HTML5 for each page accessed
+summary: Validate HTML5 for each page parsed
 test_files: []