Implement nokogiri-html5-inference to properly support HTML fragmen…

…t parsing (#696) This pull request implements the [`nokogiri-html5-inference`](https://github.com/flavorjones/nokogiri-html5-inference) to deal with parsing HTML5 fragments to be used with Selector Morphs. The `nokogiri-html5-inference` gem come about out of the discussions in #652 and sparklemotion/nokogiri#3023. Fixes #652, Resolves #692, Resolves #674 Big thanks to @flavorjones to talking and working this through with me! ## Why should this be added This pull request makes the handling of document fragments for selector morphs more natural/predictable and resolves the last open issues to release the final versions of StimulusReflex 3.5.
stimulusreflex · May 5, 2024 · 004355b · 004355b
1 parent 3f1b030
commit 004355b
Show file tree

Hide file tree

Showing 7 changed files with 647 additions and 106 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -8,6 +8,7 @@ PATH
       activesupport (>= 5.2, < 8)
       cable_ready (~> 5.0)
       nokogiri (~> 1.0)
+      nokogiri-html5-inference (~> 0.3)
       rack (>= 2, < 4)
       railties (>= 5.2, < 8)
       redis (>= 4.0, < 6.0)
@@ -127,6 +128,8 @@ GEM
       racc (~> 1.4)
     nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
+    nokogiri-html5-inference (0.3.0)
+      nokogiri (~> 1.14)
     parallel (1.22.1)
     parser (3.2.1.0)
       ast (~> 2.4.1)

diff --git a/lib/stimulus_reflex.rb b/lib/stimulus_reflex.rb
@@ -9,6 +9,7 @@
 require "action_cable"
 require "action_view"
 require "nokogiri"
+require "nokogiri/html5/inference"
 require "cable_ready"
 require "stimulus_reflex/version"
 require "stimulus_reflex/open_struct_fix"

diff --git a/lib/stimulus_reflex/html/document_fragment.rb b/lib/stimulus_reflex/html/document_fragment.rb
@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-# forzen_string_literal: true
-
 module StimulusReflex
   module HTML
     class DocumentFragment < Document
       def parsing_class
-        Nokogiri
+        Nokogiri::HTML5::Inference
+      end
+
+      def document_element
+        @document
       end
     end
   end

diff --git a/stimulus_reflex.gemspec b/stimulus_reflex.gemspec
@@ -50,6 +50,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "nokogiri", "~> 1.0"
   gem.add_dependency "rack", ">= 2", "< 4"
   gem.add_dependency "redis", ">= 4.0", "< 6.0"
+  gem.add_dependency "nokogiri-html5-inference", "~> 0.3"
 
   gem.add_development_dependency "bundler", "~> 2.0"
   gem.add_development_dependency "magic_frozen_string_literal", "~> 1.2"

diff --git a/test/broadcasters/selector_broadcaster_test.rb b/test/broadcasters/selector_broadcaster_test.rb
@@ -71,9 +71,7 @@ class SelectorBroadcasterTest < StimulusReflex::BroadcasterTestCase
         "operations" => [
           {
             "selector" => "html",
-            # Nokogiri automatically adds a `<meta>` tag for the encoding
-            # See. https://github.com/sparklemotion/nokogiri/blob/6ea1449926ce97648bb2f7401c9e4fdcb0e261ba/lib/nokogiri/html4/document.rb#L34-L35
-            "html" => "<head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><title>Test</title></head><body><div><div>bar</div><div>baz</div></div></body>",
+            "html" => "<head><title>Test</title></head><body><div><div>bar</div><div>baz</div></div></body>",
             "payload" => {},
             "childrenOnly" => true,
             "permanentAttributeName" => nil,