moxml 0.5.67 → 0.5.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 945e557e4dbc4028aa2c97eff20d12d62e34e866a1b27b788908ead119f9fbac
-  data.tar.gz: 7e327b86a60671f9824fec042b61da3a41753d8e13103062346a5941c3d14980
+  metadata.gz: d107d95a6e6c40031e9ea519397fe43ecbb08bf991ea5308bb72cc1510df0525
+  data.tar.gz: 574d6d7b1b5b211a87992b772358c0bfd96cdf0133c5cd2a2ac6547115139f02
 SHA512:
-  metadata.gz: fd59e3f68acd8471903331eff3696af0fae5e64b06a49bd7d7526a5b4ee52078bc52d763e4bc2554f8294f90a4540836f1c2c2e0a8d6f9c3505706f4383a119e
-  data.tar.gz: e5ac7c12f77a6f89e2e3e55252cf7d67acce9340d61702e344fa818f8168749e59bc91c831c41e446509134e17e9f7fc526ba8105040ef34a66ef33a3a57f984
+  metadata.gz: fc99001a56408820af4db232e682b4a5723eb1ef36545909b38144973c3b1583cca7966f89c08ee9b6d6c450bd034fc90bf53300f35e041b8f394154c18e80d7
+  data.tar.gz: 15cae743eca3abed5bcf07d4ea264974602b247b9b7edfee018ccf73b0dc4732bb2420779ee8cb90b7a6d7055fe274a51ec5d2509fab9536c056df1d9339a1cf

data/lib/moxml/adapter/customized_leptris/declaration.rb

@@ -3,10 +3,10 @@
 module Moxml
   module Adapter
     module CustomizedLeptris
-      # Wrapper for an XML declaration. libleptris stores declaration
-      # data on the document struct (read-only, serialized via options)
-      # and has no first-class declaration node, so Moxml exposes this
-      # mutable value object instead.
+      # Wrapper for an XML declaration. libleptris gained declaration
+      # setters (#1094) but has no first-class declaration node and no
+      # way to clear the state, so Moxml exposes this mutable,
+      # removable value object instead.
       class Declaration
         attr_accessor :version, :encoding, :standalone, :parent_doc
 

data/lib/moxml/adapter/customized_leptris/doctype.rb

@@ -3,9 +3,11 @@
 module Moxml
   module Adapter
     module CustomizedLeptris
-      # Wrapper for a programmatic DOCTYPE. libleptris only parses
-      # DOCTYPEs from source; it has no API to create one, so Moxml
-      # stores this value object in the document's attachments.
+      # Wrapper for a programmatic DOCTYPE. libleptris can create
+      # one (Document#set_doctype, 1.9.176 / #212) but cannot unset
+      # it, and the facade contract makes DOCTYPEs removable nodes —
+      # so Moxml keeps this value object as the lifecycle record in
+      # the document's attachments.
       class Doctype
         attr_accessor :name, :external_id, :system_id, :parent_doc
 

data/lib/moxml/adapter/customized_leptris/document_pi.rb

@@ -9,7 +9,8 @@ module Moxml
       # the root), reachable through Document#processing_instructions
       # as [target, data] pairs. This pseudo-native gives the pairs a
       # node identity so the moxml contract can list them as document
-      # children.
+      # children (and answer mutations: creation routes native via
+      # add_pi; removal has no engine entry).
       class DocumentPI
         attr_accessor :target, :data, :parent_doc
         alias content data

data/lib/moxml/adapter/customized_leptris/entity_reference.rb

@@ -3,9 +3,11 @@
 module Moxml
   module Adapter
     module CustomizedLeptris
-      # libleptris expands the five built-in entities at parse time
-      # and has no custom ones; the adapter carries entity references
-      # as Moxml::Entity::Reference values over marker-bearing text.
+      # Parse-path face: libleptris expands the five built-in entities
+      # at parse time and has no custom ones, so parsed references are
+      # carried as Moxml::Entity::Reference values over marker-bearing
+      # text. Programmatic creation is native (NATIVE_ENTITY_REFS,
+      # binding >= 1.9.177).
       EntityReference = ::Moxml::Entity::Reference
     end
   end

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

@@ -23,11 +23,13 @@ module Moxml
         def assemble_document_children(doc)
           children = []
 
-          native_doctype = doc.doctype
-          children << native_doctype if native_doctype
-
-          doctype_wrapper = attachments.get(doc, :doctype)
-          children << doctype_wrapper if doctype_wrapper
+          # Attached DOCTYPEs (NATIVE_DOC_PARTS) list the STORED
+          # native — the same object the attaching wrapper was
+          # refreshed onto — so wrapper identity holds; doc.doctype
+          # mints a fresh DocType per call and would fork wrappers.
+          doctype_native = attachments.get(doc, :doctype)
+          doctype_native = doc.doctype unless doctype_native.is_a?(::Leptris::XML::DocType)
+          children << doctype_native if doctype_native
 
           # The libxml2-model document node lists prolog PIs/comments,
           # the root, and epilog PIs/comments in document order — the
@@ -55,10 +57,25 @@ module Moxml
           when CustomizedLeptris::Declaration
             child.parent_doc = doc
             attachments.set(doc, :declaration, child)
+            mirror_declaration_native(doc, child) if NATIVE_DOC_PARTS
           when CustomizedLeptris::Doctype
+            if NATIVE_DOC_PARTS
+              dt = doc.set_doctype(child.name,
+                                   public_id: child.external_id,
+                                   system_id: child.system_id)
+              attachments.set(doc, :doctype, dt)
+              return dt
+            end
             child.parent_doc = doc
             attachments.set(doc, :doctype, child)
           when ::Leptris::XML::DocType
+            if NATIVE_DOC_PARTS
+              dt = doc.set_doctype(child.root_name,
+                                   public_id: child.public_id,
+                                   system_id: child.system_id)
+              attachments.set(doc, :doctype, dt)
+              return dt
+            end
             raise Moxml::DocumentStructureError.new(
               "libleptris does not support attaching a native DocType to a document",
             )
@@ -112,7 +129,7 @@ module Moxml
           end
 
           doctype = attachments.get(doc, :doctype)
-          parts << doctype.to_xml << "\n" if doctype
+          parts << doctype.to_xml << "\n" if doctype.is_a?(CustomizedLeptris::Doctype)
 
           native = native_doctype_xml(doc)
           parts << native << "\n" if native
@@ -304,6 +321,40 @@ module Moxml
           attachments.get(native, :had_source_declaration) ? true : false
         end
 
+        # Write a created declaration through to the engine's
+        # document state (setters, libleptris 1.9.176 / #1094) so
+        # native reads and serialization see the same truth the
+        # facade does. Removal clears it (clear_declaration).
+        def mirror_declaration_native(doc, child)
+          # The engine setters reject empty values; the facade's
+          # minimal declarations may carry them (serializer formats
+          # what it gets). Mirror only non-empty parts — the wrapper
+          # remains the record for what the facade shows.
+          unless child.version.to_s.empty?
+            ::Leptris::XML::FFI.check_status(
+              ::Leptris::XML::FFI.leptris_document_set_version(
+                doc.c_ptr, child.version.to_s
+              ),
+            )
+          end
+          unless child.encoding.to_s.empty?
+            ::Leptris::XML::FFI.check_status(
+              ::Leptris::XML::FFI.leptris_document_set_encoding(
+                doc.c_ptr, child.encoding.to_s
+              ),
+            )
+          end
+          case child.standalone.to_s
+          when "yes" then sa = 1
+          when "no" then sa = 0
+          end
+          ::Leptris::XML::FFI.check_status(
+            ::Leptris::XML::FFI.leptris_document_set_standalone(
+              doc.c_ptr, sa || -1
+            ),
+          )
+        end
+
         def marker_text_for(parent, name)
           return nil unless parent.is_a?(::Leptris::XML::Element)
 

data/lib/moxml/adapter/leptris.rb

@@ -12,9 +12,12 @@ module Moxml
     # Adapter over the leptris FFI binding (libleptris C library).
     #
     # libleptris provides DOM parsing, a native XPath 1.0 engine, SAX,
-    # and serialization. It has no first-class XML declaration or
-    # programmatic DOCTYPE, so those live in CustomizedLeptris value
-    # objects stored through NativeAttachment.
+    # and serialization. Its document-level creation surfaces exist
+    # (set_doctype 1.9.176/#212, declaration setters #1094) but are
+    # SET-ONLY — no unset for declaration, DOCTYPE, or document PIs —
+    # while the moxml facade contract makes those parts removable
+    # nodes. CustomizedLeptris value objects therefore remain the
+    # lifecycle record, attached through NativeAttachment.
     class Leptris < Base
       # The binding floor (issue #149): 1.9.32 carried the traverse
       # fix (leptris-ruby#89) and made built documents reflect their
@@ -551,6 +554,16 @@ module Moxml
         (!defined?(::Leptris::XML::Native) ||
          ::Leptris::XML::Native.respond_to?(:plan_structs))
 
+      # leptris-ruby#275 (binding 1.9.204, the remove half of the
+      # document-level surfaces): remove_pi, clear_declaration,
+      # remove_doctype complete the set-only creation entries.
+      # Attached DOCTYPEs materialize as native nodes, document-PI
+      # removal works, and declaration state mirrors through.
+      NATIVE_DOC_PARTS =
+        Gem::Version.new(::Leptris::VERSION) >= Gem::Version.new("1.9.204.0") &&
+        ::Leptris::XML::Document.method_defined?(:remove_doctype) &&
+        ::Leptris::XML::Document.method_defined?(:clear_declaration)
+
       def self.plan_structs(native, spec)
         return nil unless NATIVE_PLAN_STRUCTS
 
@@ -954,6 +967,9 @@ module Moxml
         def remove_declaration(native_doc)
           attachments.delete(native_doc, :declaration)
           attachments.delete(native_doc, :had_source_declaration)
+          if NATIVE_DOC_PARTS && native_doc.is_a?(::Leptris::XML::Document)
+            native_doc.clear_declaration
+          end
         end
 
         def create_native_namespace(element, prefix, uri)
@@ -1496,6 +1512,15 @@ module Moxml
           attr
         end
 
+        def actual_native(child_native, parent_native)
+          if NATIVE_DOC_PARTS && child_native.is_a?(CustomizedLeptris::Doctype) &&
+              parent_native.is_a?(::Leptris::XML::Document)
+            attached = attachments.get(parent_native, :doctype)
+            return attached if attached.is_a?(::Leptris::XML::DocType)
+          end
+          child_native
+        end
+
         def add_child(parent, child)
           if NATIVE_READ_LAYER && !(NATIVE_MUTATIONS_COHERENT &&
                    parent.is_a?(::Leptris::XML::NativeNode) &&
@@ -1588,14 +1613,33 @@ module Moxml
             remove_declaration(node.parent_doc) if node.parent_doc
           when CustomizedLeptris::Doctype
             attachments.delete(node.parent_doc, :doctype) if node.parent_doc
+          when ::Leptris::XML::DocType
+            if NATIVE_DOC_PARTS
+              doc = node.document || doc_for(node)
+              if doc
+                doc.remove_doctype
+                attachments.delete(doc, :doctype)
+              end
+            end
           when CustomizedLeptris::EntityReference
             marker_text_for(node.parent, node.name)&.unlink
           when CustomizedLeptris::DocumentPI
-            raise Moxml::NotImplementedError.new(
-              "libleptris has no document-level PI removal",
-              adapter: :leptris,
-              feature: :remove,
-            )
+            if NATIVE_DOC_PARTS && node.parent_doc
+              pis = node.parent_doc.processing_instructions
+              index = pis.index do |target, data|
+                target == node.target && data == node.data
+              end
+              if index
+                node.parent_doc.remove_pi(index)
+                node.parent_doc = nil
+              end
+            else
+              raise Moxml::NotImplementedError.new(
+                "libleptris has no document-level PI removal",
+                adapter: :leptris,
+                feature: :remove,
+              )
+            end
           else
             node.unlink
           end

data/lib/moxml/version.rb

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

data/spec/moxml/adapter/leptris_doc_parts_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+begin
+  require "leptris"
+rescue LoadError
+  return
+end
+
+require "moxml/adapter/leptris"
+
+# leptris-ruby#275 (binding 1.9.204, the remove half): attached
+# DOCTYPEs materialize as native nodes with wrapper identity, and
+# document-PI removal / declaration clear work natively. Below the
+# gate the legacy CustomizedLeptris paths keep the contract.
+RSpec.describe Moxml::Adapter::Leptris do
+  around do |example|
+    Moxml.with_config(:leptris, true, "UTF-8") do
+      example.run
+    end
+  end
+
+  let(:ctx) { Moxml.new(:leptris) }
+  let(:gate) do
+    Moxml::Adapter::Leptris::NATIVE_DOC_PARTS
+  end
+
+  describe "created DOCTYPE as a native node" do
+    it "attaches, lists once with wrapper identity, serializes, and removes" do
+      skip "requires binding 1.9.204+ (leptris-ruby#275)" unless gate
+
+      doc = ctx.parse("<root/>")
+      doctype = doc.create_doctype("root", "-//X//DTD Y//EN", "y.dtd")
+      doc.add_child(doctype)
+
+      listed = doc.children.grep(Moxml::Doctype)
+      expect(listed.size).to eq(1)
+      expect(listed.first).to equal(doctype)
+      expect(doc.to_xml)
+        .to include(%(<!DOCTYPE root PUBLIC "-//X//DTD Y//EN" "y.dtd">))
+
+      doctype.remove
+      expect(doc.children).to all(be_a(Moxml::Element))
+      expect(doc.to_xml).not_to include("DOCTYPE")
+    end
+  end
+
+  describe "document-level PI removal" do
+    it "removes the PI from children and serialization" do
+      skip "requires binding 1.9.204+ (leptris-ruby#275)" unless gate
+
+      doc = ctx.parse("<root/>")
+      doc.add_child(doc.create_processing_instruction("before", "data"))
+      expect(doc.children.count { |c| c.is_a?(Moxml::ProcessingInstruction) })
+        .to eq(1)
+
+      doc.children
+        .find { |c| c.is_a?(Moxml::ProcessingInstruction) }
+        .remove
+      expect(doc.children.count { |c| c.is_a?(Moxml::ProcessingInstruction) })
+        .to eq(0)
+      expect(doc.to_xml).not_to include("<?before")
+    end
+  end
+
+  describe "declaration mirroring" do
+    it "writes created declarations through to engine state and clears on remove" do
+      skip "requires binding 1.9.204+ (leptris-ruby#275)" unless gate
+
+      doc = ctx.parse("<root/>")
+      declaration = doc.create_declaration("1.1", "UTF-8", "yes")
+      doc.add_child(declaration)
+
+      ffi = Leptris::XML::FFI
+      native = doc.native
+      expect(ffi.leptris_document_version(native.c_ptr)).to eq("1.1")
+      expect(ffi.leptris_document_standalone(native.c_ptr)).to eq(1)
+      expect(doc.to_xml).to include(%(version="1.1"))
+      expect(doc.to_xml).to include(%(standalone="yes"))
+
+      declaration.remove
+      expect(doc.to_xml).not_to include("version=")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moxml
 version: !ruby/object:Gem::Version
-  version: 0.5.67
+  version: 0.5.69
 platform: ruby
 authors:
 - Ribose Inc.
@@ -433,6 +433,7 @@ files:
 - spec/moxml/adapter/base_spec.rb
 - spec/moxml/adapter/entity_restoration_spec.rb
 - spec/moxml/adapter/headed_ox_spec.rb
+- spec/moxml/adapter/leptris_doc_parts_spec.rb
 - spec/moxml/adapter/leptris_spec.rb
 - spec/moxml/adapter/libxml_internals_spec.rb
 - spec/moxml/adapter/libxml_spec.rb