capybara-validate_html5 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abeb0e5a54618097048f3476bc49bf454afe6bff7ac5ccb56ac46bdf4ec0ea12
+  data.tar.gz: a2f0356a2d583be4d9c985803bc809df7dd4e8ad71b9c96a524d037f756ae346
+SHA512:
+  metadata.gz: c93d81860de762973748165f13192543cc546ec3f0d5d2ed07bf60e70ac429675f0f1a4cff4bdc625d126806640f6221510f85c2f320ea2533ea676b9b8dcbbb
+  data.tar.gz: d612c465456403978375ec3059e0fdb47df0a7658f149f3a0f9777d3340cfe1a88bd16f000fb8bdf176adabeb765a068330f481aed6af5bc7f6bcd4112189579

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2022-03-07)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2022 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
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+= capybara-validate_html5
+
+capybara-validate_html5 validates the HTML5 for each page accessed, 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.
+
+= Installation
+
+  gem install capybara-validate_html5
+
+= Source Code
+
+Source code is available on GitHub at https://github.com/jeremyevans/capybara-validate_html5
+
+= Examples
+
+  require 'capybara'
+  require 'capybara/validate_html5'
+
+  describe Capybara::RestoreState do
+    include Rack::Test::Methods
+    include Capybara::DSL
+
+    def app
+      MyRackApp
+    end
+
+    it "should allow restoring of state" do
+      visit '/' # validates HTML, fails spec if not valid
+
+      skip_html_validation do
+        click_button 'Submit' # doesn't validate resulting HTML
+      end
+
+      click_link 'Go Somewhere' # validates HTML, fails spec if not valid
+    end
+  end
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/lib/capybara/validate_html5.rb

@@ -0,0 +1,63 @@
+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
+
+      # 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}
+
+#{html.split("\n")[begin_line..end_line].join("\n")}
+
+END_MSG
+          end
+        end
+        super
+      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
+  else
+    module DSL
+      # If HTML5 validation isn't supported, make this
+      # a no-op.
+      def skip_html_validation(&block)
+        yield
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: capybara-validate_html5
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  capybara-validate validates the HTML5 for each page accessed, 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.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- lib/capybara/validate_html5.rb
+homepage: http://github.com/jeremyevans/capybara-validate_html5
+licenses:
+- MIT
+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'
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Validate HTML5 for each page accessed
+test_files: []