relaton-bib 2.1.7 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d36c3ed1e4ae0042f96a06a6320dccbe089a87a691b77b8ad14e276217bd22
-  data.tar.gz: d6db31f185b72668da0c289bc462a62d1cfd1b9dda542f37b9dee7257d5282b4
+  metadata.gz: 74bf6a3c3abe13cbadc903c2d2b811b125f654033e092ed33305834663404854
+  data.tar.gz: 396420681c9fe3567117b7e6a992c56a0cbfd3b219d36d650d8deb072a36435b
 SHA512:
-  metadata.gz: 304fcb5b02e2c019d532164228acede4ed81c210eafededbbdd9446ac94fcd32d142be5be7689db09bc17b7aa3e6cfb333b892220ba36e64fcccc2bdda2df29c
-  data.tar.gz: 390cf8b808ab85b099d573b4bea833d265a2326d81c00936e5cebe6ae79c9243991843d44a46d3d24e403137f1ec27b433acc532c51f99a0d5e91d0ed66d6744
+  metadata.gz: 9fdb28c540d26dd47ac56af80c292cae33f6cafa96672161d732f85e457b4a7336c2c5f11d5f5b852284433f73b08cfefe7d2af0c1e2d99e1557c05f985f46da
+  data.tar.gz: 1585a8df0f2a2ad420eb26ed1d11a6f36483f90f10510f3cb63f72145d0d401b4499016100475b37195f31033d4c600bd281d8d4f97b7f648732212f7a5378b2

data/lib/relaton/bib/sanitizer.rb

@@ -42,15 +42,151 @@ module Relaton
 
       TAG_RX = %r{<[a-zA-Z/!?]}
 
+      # Captures a namespace prefix, on a tag or on an attribute: the
+      # "jats" of <jats:p> and </jats:italic>, and the "xlink" of
+      # xlink:href.
+      NS_PREFIX_RX = %r{(?:</?|\s)([A-Za-z_][\w.-]*):(?=[A-Za-z_])}
+
+      # Namespace that declares a prefix which the content leaves
+      # undeclared. The sanitiser removes it again before it serialises.
+      NS_PLACEHOLDER = "urn:x-relaton-undeclared:%s".freeze
+
+      # Element that carries the placeholder declarations. Its children
+      # are the sanitised content, so the element itself never reaches
+      # the output.
+      NS_WRAPPER = "relaton-sanitizer-root".freeze
+
+      # Reserved prefixes. XML declares both, so the content must not.
+      NS_RESERVED = %w[xml xmlns].freeze
+
+      # Serialise without the FORMAT option, so the sanitiser keeps the
+      # shape of element-only content instead of adding newlines and
+      # indent.
+      SAVE_OPTS = Nokogiri::XML::Node::SaveOptions::AS_XML
+
       def self.sanitize(content)
         return content unless sanitizable?(content)
 
+        node = parse(content)
+        return content if node.nil?
+
+        sanitize_children(node)
+        node.children.map do |c|
+          c.to_xml(encoding: "UTF-8", save_with: SAVE_OPTS)
+        end.join
+      end
+
+      #
+      # Parse the content into a node whose children are the content.
+      #
+      # @param [String] content The raw marked-up content.
+      #
+      # @return [Nokogiri::XML::Node, nil] The node, or nil when the
+      #   content does not parse.
+      #
+      def self.parse(content)
         fragment = Nokogiri::XML::DocumentFragment.parse(content)
-        return content if fragment.errors.any?
+        return fragment if fragment.errors.empty?
+
+        parse_with_prefixes(content)
+      end
+      private_class_method :parse
 
-        sanitize_children(fragment)
-        fragment.children.map { |c| c.to_xml(encoding: "UTF-8") }.join
+      #
+      # Parse content that uses undeclared namespace prefixes.
+      #
+      # An undeclared prefix is always a parse error, so without this the
+      # sanitiser gives up on exactly the third-party markup that needs
+      # sanitising most. Declare every prefix that the content uses on a
+      # wrapper element, parse, then remove the placeholder namespaces
+      # from the elements and from the attributes. See metanorma-pdfa#99.
+      #
+      # An undeclared prefix inside an OPAQUE <stem> goes as well. The
+      # sanitiser cannot keep it: an undeclared prefix in the output is
+      # the exact failure that this method removes. Only a namespace that
+      # the content declares itself survives verbatim.
+      #
+      # @param [String] content The raw marked-up content.
+      #
+      # @return [Nokogiri::XML::Element, nil] The wrapper element, or nil
+      #   when the content uses no prefix or does not parse.
+      #
+      def self.parse_with_prefixes(content)
+        decl = placeholder_declarations(content) or return
+        name = wrapper_name(content)
+        doc = Nokogiri::XML "<#{name} #{decl}>#{content}</#{name}>"
+        return unless doc.errors.empty?
+
+        drop_placeholder_namespaces doc.root
+      end
+      private_class_method :parse_with_prefixes
+
+      #
+      # Declare every namespace prefix that the content uses.
+      #
+      # @param [String] content The raw marked-up content.
+      #
+      # @return [String, nil] The declarations, or nil when the content
+      #   uses no prefix.
+      #
+      def self.placeholder_declarations(content)
+        prefixes = content.scan(NS_PREFIX_RX).flatten.uniq - NS_RESERVED
+        return if prefixes.empty?
+
+        prefixes.map do |pfx|
+          %(xmlns:#{pfx}="#{format NS_PLACEHOLDER, pfx}")
+        end.join(" ")
+      end
+      private_class_method :placeholder_declarations
+
+      #
+      # Name a wrapper element that the content does not close itself.
+      #
+      # Content that holds the literal end tag of the wrapper would close
+      # it early. The document then has more than one root, the parse
+      # fails, and the sanitiser gives up on content that it can handle.
+      #
+      # @param [String] content The raw marked-up content.
+      #
+      # @return [String] A name that the content does not contain.
+      #
+      def self.wrapper_name(content)
+        name = NS_WRAPPER
+        name += "-x" while content.include?(name)
+        name
+      end
+      private_class_method :wrapper_name
+
+      #
+      # Remove the placeholder namespaces, and only those.
+      #
+      # Nokogiri's remove_namespaces! would also strip a namespace that
+      # the content declares itself, such as the MathML xmlns inside an
+      # OPAQUE <stem>, which must survive verbatim. Match the wrapper's
+      # own declarations, so a namespace of the content never matches,
+      # whatever its URI.
+      #
+      # The declarations stay on the wrapper element. Only its children
+      # reach the output, so the declarations never leak. Do not
+      # serialise the root itself.
+      #
+      # @param [Nokogiri::XML::Element] root The wrapper element.
+      #
+      # @return [Nokogiri::XML::Element] The same element.
+      #
+      def self.drop_placeholder_namespaces(root)
+        placeholders = root.namespace_definitions
+        root.traverse do |node|
+          node.namespace = nil if placeholders.include?(node.namespace)
+          next unless node.element?
+
+          node.attribute_nodes.each do |attr|
+            attr.namespace = nil if placeholders.include?(attr.namespace)
+          end
+        end
+        root
       end
+      private_class_method :drop_placeholder_namespaces
 
       def self.sanitizable?(content)
         content.is_a?(::String) && !content.empty? && content.match?(TAG_RX)

data/lib/relaton/bib/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Bib
-    VERSION = "2.1.7".freeze
+    VERSION = "2.1.9".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-31 00:00:00.000000000 Z
+date: 2026-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby