moxml 0.5.16 → 0.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39cfbe08ea2a0e92f2ba89e83beacf564401765e964807dc4d73ca23d867af38
-  data.tar.gz: cdd5d499fd4b3233a6c4d2774b188aef2339f341f7c7a7112a82ac392ec4e53b
+  metadata.gz: 6de47d8ce88e56853b7523dfbcb2049e61d586878dca573d13bacd85138b4a4e
+  data.tar.gz: 520a050794c1275e5bc519454319a34fd059b9bbcf3f0efd0f5d8e0876bb7e97
 SHA512:
-  metadata.gz: 894d6bacdd4f26dbb2a59b0684b29e8ca68b39b66f841a5cd11005351eff38404e745b47d58bb860c898d3da92e1e2a769210938f26cac2f88cac34cc887de76
-  data.tar.gz: c5b7b7c9de4f2362e910b740ce4cf6185a72773f39f31a3dfc17fbd7436f65f542e66ff099900bf9073e87bd5975568cb3833ac658115ea5ee21a4218719ce90
+  metadata.gz: 6b197e6da24e0b40ead4fa25ee944b242ee3484475b2927a16e126faa208f8ff4bb7709795b1d2830b1394fbb0fad8d28f99ed32ec9dbf902710752286965e7c
+  data.tar.gz: 89b1ae523cf06687e67e4d07a088cdef2f942a1b4dcff8ba56f468fb887b1ac3bba936b10145c057eb0f6cf767c9e7ba35e86fb753854ee391f29951f2e17485

data/docs/_pages/adapter-protocol.adoc

@@ -55,7 +55,9 @@ the tracked native; wrappers re-key through `refresh_native!`.
 
 Serialization::
 `serialize(node, options)`. Options: `indent`, `encoding`,
-`declaration`, `no_declaration`, `expand_empty`, `line_ending`.
+`declaration`, `no_declaration`, `expand_empty`, `line_ending`,
+`indent_text` (the indent-unit string — honored where the engine
+has it, e.g. Nokogiri; leptris waits on leptris-ruby#109).
 Entity-marker restoration is owned by the wrapper layer
 (`Node#to_xml`), guarded by `entity_bearing?`.
 

data/docs/_pages/adapters/leptris.adoc

@@ -62,16 +62,18 @@ implementation over one `leptris_node_traverse` call.
 
 == Known limitations (tracked upstream)
 
-* Tab indentation (`indent_text`) needs a serialize-time parameter in
-  libleptris; post-hoc rewriting would corrupt mixed content.
-* Child PIs serialize inline (engine emits `<r>\n<?pi x?>  <e/>`
-  rather than libxml2's one-PI-per-indented-line layout); safe
-  post-hoc rewriting is impossible in mixed content.
-* DOCTYPE internal subsets serialize inline; libxml2 separates the
-  declarations with newlines.
-* Document-level PIs are read-only natives (`target=`/`data=`/
-  `unlink` rejected); write-through and removal are pending C
-  surface (leptris/leptris#612).
 * A PI preceding the DOCTYPE reorders on serialization — libleptris
   normalizes DOCTYPE-first and the document node does not record its
   relative position.
+* Tab indentation: the binding's `indent_text` is the display-form
+  boolean, not Nokogiri's indent-unit string — the unit ask is
+  leptris-ruby#109. moxml forwards `indent_text:` to Nokogiri
+  meanwhile.
+
+Resolved with leptris-ruby 1.9.42 (leptris/leptris#636/#612): child
+PIs serialize on their own indented lines, DOCTYPE internal subsets
+newline-separate their declarations (moxml re-formats the subset to
+the libxml2 layout), the stray trailing newline after non-ASCII
+ending elements is gone engine-side, and document-level PIs accept
+`target=`/`content=`/removal with full round-trip. The moxml-side
+compat guards remain as no-ops for older floor bindings.

data/docs/_pages/conversion-apis.adoc

@@ -100,4 +100,9 @@ context.parse(src).to_xml(
 ) == Nokogiri::XML(src).to_xml(indent: 2, encoding: "UTF-8")   # => true
 ----
 
-Known residual divergences (engine-level, tracked upstream): tab indentation needs a serialize-time parameter in libleptris, and a PI preceding the DOCTYPE reorders (the engine normalizes DOCTYPE-first).
+Known residual divergences (engine-level, tracked upstream): a PI
+preceding the DOCTYPE reorders (the engine normalizes DOCTYPE-first),
+and tab indentation waits on the binding exposing an indent-unit
+parameter (leptris-ruby#109) — child-PI lines, DOCTYPE subset
+layout, and the non-ASCII trailing-newline quirk were resolved with
+leptris-ruby 1.9.42.

data/lib/moxml/adapter/leptris/document_parts.rb

@@ -113,9 +113,75 @@ module Moxml
           return nil unless dt
 
           subset = dt.internal_subset if dt.class.method_defined?(:internal_subset)
+          subset = format_internal_subset(subset) if LIBXML2_LAYOUT_PARITY
           XmlEmitter.doctype_xml(dt.root_name, dt.public_id, dt.system_id, subset)
         end
 
+        # libxml2's DTD dump layout (leptris/leptris#636): newline
+        # after "[", one after every markup declaration, none after
+        # comments (they glue to both neighbors); an empty subset
+        # drops the brackets. Returns the INNER text for
+        # XmlEmitter.doctype_xml, nil when there is nothing to emit.
+        # The engine reports internal_subset as raw source text, so
+        # the declarations are re-tokenized — quote-aware, since an
+        # attribute default can contain ">".
+        def format_internal_subset(subset)
+          return nil if subset.nil? || subset.empty?
+
+          out = +"\n"
+          pos = 0
+          length = subset.length
+          while pos < length
+            start = subset.index("<", pos)
+            break if start.nil?
+
+            terminator, skip = if subset[start, 4] == "<!--"
+                                 ["-->", 4]
+                               elsif subset[start, 2] == "<?"
+                                 ["?>", 2]
+                               else
+                                 [nil, 0]
+                               end
+            if terminator
+              stop = subset.index(terminator, start + skip)
+              break if stop.nil?
+
+              item_end = stop + terminator.length
+            else
+              item_end = markup_decl_end(subset, start)
+              break if item_end.nil?
+            end
+            out << subset[start...item_end]
+            # Comments carry no trailing newline; declarations do.
+            out << "\n" unless subset[start, 4] == "<!--"
+            pos = item_end
+          end
+          out == "\n" ? nil : out
+        end
+
+        # End index of a markup declaration starting at `start`:
+        # the first ">" outside quotes.
+        QUOTE_CHARS = ['"', "'"].freeze
+        private_constant :QUOTE_CHARS
+
+        def markup_decl_end(subset, start)
+          quote = nil
+          i = start
+          length = subset.length
+          while i < length
+            ch = subset[i]
+            if quote
+              quote = nil if ch == quote
+            elsif QUOTE_CHARS.include?(ch)
+              quote = ch
+            elsif ch == ">"
+              return i + 1
+            end
+            i += 1
+          end
+          nil
+        end
+
         def default_declaration_xml(doc, options)
           encoding = options[:encoding] || doc.encoding
           encoding = "UTF-8" if encoding.to_s.empty?

data/lib/moxml/adapter/leptris/serialize.rb

@@ -70,7 +70,10 @@ module Moxml
           )
           # Element output always ends with the close tag — but the
           # engine's serializer appends a stray trailing newline when
-          # the element's last text child is non-ASCII.
+          # the element's last text child is non-ASCII (fixed engine
+          # side in 1.9.42; kept for older floor bindings). Note: the
+          # binding's indent_text kwarg is the display-form boolean,
+          # not Nokogiri's indent-unit string — do not forward it.
           xml.sub(/\n+\z/, "")
         end
 

data/lib/moxml/adapter/leptris.rb

@@ -31,6 +31,15 @@ module Moxml
       PREFIXED_ATTR_PREDICATES_NATIVE =
         Gem::Version.new(::Leptris::VERSION) >= Gem::Version.new("1.9.40")
 
+      # leptris/leptris#636 (leptris-ruby 1.9.42): libxml2-compatible
+      # pretty-print — child-PI lines, DOCTYPE internal-subset layout,
+      # no stray trailing newline after non-ASCII text, and the indent
+      # unit (`to_xml`'s indent_text takes the unit string). Older
+      # floor bindings treat indent_text as a display-form boolean, so
+      # the passthrough and the parity pins gate on this.
+      LIBXML2_LAYOUT_PARITY =
+        Gem::Version.new(::Leptris::VERSION) >= Gem::Version.new("1.9.42")
+
       NO_PARSE_ERRORS = [].freeze
       private_constant :NO_PARSE_ERRORS
 

data/lib/moxml/adapter/nokogiri.rb

@@ -429,11 +429,13 @@ module Moxml
             custom_decl = "<?xml #{attrs.join(' ')}?>"
           end
 
-          result = node.to_xml(
+          serialize_kwargs = {
             indent: options[:indent],
             encoding: options[:encoding],
             save_with: save_options,
-          )
+          }
+          serialize_kwargs[:indent_text] = options[:indent_text] if options[:indent_text]
+          result = node.to_xml(**serialize_kwargs)
 
           if custom_decl
             result = "#{custom_decl}\n#{result}"

data/lib/moxml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Moxml
-  VERSION = "0.5.16"
+  VERSION = "0.5.17"
 end

data/spec/moxml/adapter/leptris_spec.rb

@@ -157,6 +157,15 @@ RSpec.describe Moxml::Adapter::Leptris do
         selfclosing: %(<r><a/><b/><c>t</c><d/></r>),
       }
 
+      # leptris/leptris#636 (binding 1.9.42): child-PI lines and
+      # DOCTYPE internal-subset layout match libxml2.
+      if defined?(described_class::LIBXML2_LAYOUT_PARITY) && described_class::LIBXML2_LAYOUT_PARITY
+        cases[:pi_child] = %(<r><?pi data?><e/></r>)
+        cases[:pi_child_mixed] = %(<r>t<?pi d?><e>x</e>u</r>)
+        cases[:doctype_subset] = %(<?xml version="1.0"?><!DOCTYPE r [<!ELEMENT r (#PCDATA)>]><r>t</r>)
+        cases[:doctype_subset_multi] = %(<?xml version="1.0"?><!DOCTYPE r [<!ELEMENT r (#PCDATA)><!ATTLIST e a CDATA "d">]><r><e/></r>)
+      end
+
       cases.each do |name, source|
         target = Nokogiri::XML(source).to_xml(indent: 2, encoding: "UTF-8")
         output = ctx.parse(source).to_xml(
@@ -166,6 +175,16 @@ RSpec.describe Moxml::Adapter::Leptris do
       end
     end
 
+    it "round-trips document-level PI mutations through serialization" do
+      # leptris/leptris#612: parse-created document PIs carry doc
+      # linkage — the setters work and the tree round-trips.
+      doc = ctx.parse("<?pi-prolog before?><root/>")
+      pi = doc.children.to_a.first
+      pi.target = "renamed"
+      pi.content = "changed"
+      expect(doc.to_xml).to include("<?renamed changed?>")
+    end
+
     it "reports the tracked native for a re-added document PI" do
       doc = ctx.parse("<?pi-src orig?><root/>")
       moved = doc.children.to_a[0]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moxml
 version: !ruby/object:Gem::Version
-  version: 0.5.16
+  version: 0.5.17
 platform: ruby
 authors:
 - Ribose Inc.