moxml 0.1.0 → 0.1.1

data/lib/moxml/adapter/base.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "../xml_utils"
+require_relative "../document_builder"
+
+module Moxml
+  module Adapter
+    class Base
+      # include XmlUtils
+
+      class << self
+        include XmlUtils
+
+        def set_root(doc, element)
+          raise NotImplementedError
+        end
+
+        def parse(xml, options = {})
+          raise NotImplementedError
+        end
+
+        def create_document
+          raise NotImplementedError
+        end
+
+        def create_element(name)
+          validate_element_name(name)
+          create_native_element(name)
+        end
+
+        def create_text(content)
+          create_native_text(normalize_xml_value(content))
+        end
+
+        def create_cdata(content)
+          create_native_cdata(normalize_xml_value(content))
+        end
+
+        def create_comment(content)
+          validate_comment_content(content)
+          create_native_comment(normalize_xml_value(content))
+        end
+
+        def create_doctype(name, external_id, system_id)
+          create_native_doctype(name, external_id, system_id)
+        end
+
+        def create_processing_instruction(target, content)
+          validate_pi_target(target)
+          create_native_processing_instruction(target, normalize_xml_value(content))
+        end
+
+        def create_declaration(version = "1.0", encoding = "UTF-8", standalone = nil)
+          validate_declaration_version(version)
+          validate_declaration_encoding(encoding)
+          validate_declaration_standalone(standalone)
+          create_native_declaration(version, encoding, standalone)
+        end
+
+        def create_namespace(element, prefix, uri)
+          validate_prefix(prefix) if prefix
+          validate_uri(uri)
+          create_native_namespace(element, prefix, uri)
+        end
+
+        protected
+
+        def create_native_element(name)
+          raise NotImplementedError
+        end
+
+        def create_native_text(content)
+          raise NotImplementedError
+        end
+
+        def create_native_cdata(content)
+          raise NotImplementedError
+        end
+
+        def create_native_comment(content)
+          raise NotImplementedError
+        end
+
+        def create_native_doctype(name, external_id, system_id)
+          raise NotImplementedError
+        end
+
+        def create_native_processing_instruction(target, content)
+          raise NotImplementedError
+        end
+
+        def create_native_declaration(version, encoding, standalone)
+          raise NotImplementedError
+        end
+
+        def create_native_namespace(element, prefix, uri)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/moxml/adapter/customized_oga/xml_declaration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "oga"
+
+module Moxml
+  module Adapter
+    module CustomizedOga
+      class XmlDeclaration < ::Oga::XML::XmlDeclaration
+        def initialize(options = {})
+          @version    = options[:version] || "1.0"
+          # encoding is optional, but Oga sets it to UTF-8 by default
+          @encoding   = options[:encoding]
+          @standalone = options[:standalone]
+        end
+      end
+    end
+  end
+end

data/lib/moxml/adapter/customized_oga/xml_generator.rb

@@ -0,0 +1,104 @@
+# rubocop:disable Style/FrozenStringLiteralComment
+
+require "oga"
+
+# monkey patch the Oga generator because it's not configurable
+# https://github.com/yorickpeterse/oga/blob/main/lib/oga/xml/generator.rb
+module Moxml
+  module Adapter
+    module CustomizedOga
+      class XmlGenerator < ::Oga::XML::Generator
+        def self_closing?(_element)
+          # Always expand tags
+          false
+        end
+
+        def on_element(element, output)
+          name = element.expanded_name
+
+          attrs = ""
+          element.attributes.each do |attr|
+            attrs << " "
+            on_attribute(attr, attrs)
+          end
+
+          closing_tag = if self_closing?(element)
+                          html_void_element?(element) ? ">" : " />"
+                        else
+                          ">"
+                        end
+
+          output << "<#{name}#{attrs}#{closing_tag}"
+        end
+
+        def on_namespace_definition(ns, output)
+          name = "xmlns"
+          name += ":#{ns.name}" unless ns.name.nil?
+
+          output << %(#{name}="#{ns.uri}")
+        end
+
+        def on_attribute(attr, output)
+          return super unless attr.value&.include?("'")
+
+          output << %(#{attr.expanded_name}="#{encode(attr.value)}")
+        end
+
+        def on_cdata(node, output)
+          # Escape the end sequence
+          return super unless node.text.include?("]]>")
+
+          chunks = node.text.split(/(\]\]>)/)
+          chunks = ["]]", ">"] if chunks.size == 1
+
+          while (index = chunks.index("]]>"))
+            # the end tag cannot be the first and the last at the same time
+
+            if index.zero?
+              # it's the first text chunk
+              chunks[index] = "]]"
+              chunks[index + 1] = ">#{chunks[index + 1]}"
+            elsif index - 1 == chunks.size
+              # it's the last text chunk
+              chunks[index - 1] += "]]"
+              chunks[index] = ">"
+            else
+              # it's a chunk in the middle
+              chunks[index - 1] += "]]"
+              chunks[index + 1] = ">#{chunks[index + 1]}"
+              chunks.delete_at(index)
+            end
+          end
+
+          chunks.each do |chunk|
+            output << "<![CDATA[#{chunk}]]>"
+          end
+
+          output
+        end
+
+        def on_processing_instruction(node, output)
+          # put the space between the name and text
+          output << "<?#{node.name} #{node.text}?>"
+        end
+
+        def on_xml_declaration(node, output)
+          super
+          # remove the space before the closing tag
+          output.gsub!(/ \?>$/, "?>")
+        end
+
+        protected
+
+        def encode(input)
+          # similar to ::Oga::XML::Entities.encode_attribute
+          input&.gsub(
+            ::Oga::XML::Entities::ENCODE_ATTRIBUTE_REGEXP,
+            # Keep apostrophes in attributes
+            ::Oga::XML::Entities::ENCODE_ATTRIBUTE_MAPPING.merge("'" => "'")
+          )
+        end
+      end
+    end
+  end
+end

data/lib/moxml/adapter/nokogiri.rb

@@ -0,0 +1,314 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require "nokogiri"
+
+module Moxml
+  module Adapter
+    class Nokogiri < Base
+      class << self
+        def set_root(doc, element)
+          doc.root = element
+        end
+
+        def parse(xml, options = {})
+          native_doc = begin
+            if options[:fragment]
+              ::Nokogiri::XML::DocumentFragment.parse(xml) do |config|
+                config.strict.nonet
+                config.recover unless options[:strict]
+              end
+            else
+              ::Nokogiri::XML(xml, nil, options[:encoding]) do |config|
+                config.strict.nonet
+                config.recover unless options[:strict]
+              end
+            end
+          rescue ::Nokogiri::XML::SyntaxError => e
+            raise Moxml::ParseError.new(e.message, line: e.line, column: e.column)
+          end
+
+          DocumentBuilder.new(Context.new(:nokogiri)).build(native_doc)
+        end
+
+        def create_document
+          ::Nokogiri::XML::Document.new
+        end
+
+        def create_fragment
+          # document fragments are weird and should be used with caution:
+          # https://github.com/sparklemotion/nokogiri/issues/572
+          ::Nokogiri::XML::DocumentFragment.new(
+            ::Nokogiri::XML::Document.new
+          )
+        end
+
+        def create_native_element(name)
+          ::Nokogiri::XML::Element.new(name, create_document)
+        end
+
+        def create_native_text(content)
+          ::Nokogiri::XML::Text.new(content, create_document)
+        end
+
+        def create_native_cdata(content)
+          ::Nokogiri::XML::CDATA.new(create_document, content)
+        end
+
+        def create_native_comment(content)
+          ::Nokogiri::XML::Comment.new(create_document, content)
+        end
+
+        def create_native_doctype(name, external_id, system_id)
+          create_document.create_internal_subset(
+            name, external_id, system_id
+          )
+        end
+
+        def create_native_processing_instruction(target, content)
+          ::Nokogiri::XML::ProcessingInstruction.new(
+            ::Nokogiri::XML::Document.new, target, content
+          )
+        end
+
+        def create_native_declaration(version, encoding, standalone)
+          ::Nokogiri::XML::ProcessingInstruction.new(
+            create_document,
+            "xml",
+            build_declaration_attrs(version, encoding, standalone)
+          )
+        end
+
+        def declaration_attribute(declaration, attr_name)
+          return nil unless declaration.content
+
+          match = declaration.content.match(/#{attr_name}="([^"]*)"/)
+          match && match[1]
+        end
+
+        def set_declaration_attribute(declaration, attr_name, value)
+          attrs = current_declaration_attributes(declaration)
+          if value.nil?
+            attrs.delete(attr_name)
+          else
+            attrs[attr_name] = value
+          end
+
+          declaration.native_content =
+            attrs.map { |k, v| %(#{k}="#{v}") }.join(" ")
+        end
+
+        def set_namespace(element, ns)
+          element.namespace = ns
+        end
+
+        def namespace(element)
+          element.namespace
+        end
+
+        def processing_instruction_target(node)
+          node.name
+        end
+
+        def create_native_namespace(element, prefix, uri)
+          element.add_namespace_definition(prefix, uri)
+        end
+
+        def node_type(node)
+          case node
+          when ::Nokogiri::XML::Element then :element
+          when ::Nokogiri::XML::CDATA then :cdata
+          when ::Nokogiri::XML::Text then :text
+          when ::Nokogiri::XML::Comment then :comment
+          when ::Nokogiri::XML::ProcessingInstruction then :processing_instruction
+          when ::Nokogiri::XML::Document, ::Nokogiri::XML::DocumentFragment then :document
+          when ::Nokogiri::XML::DTD then :doctype
+          else :unknown
+          end
+        end
+
+        def node_name(node)
+          node.name
+        end
+
+        def set_node_name(node, name)
+          node.name = name
+        end
+
+        def children(node)
+          node.children.reject do |child|
+            child.text? && child.content.strip.empty? &&
+              !(child.previous_sibling.nil? && child.next_sibling.nil?)
+          end
+        end
+
+        def replace_children(node, new_children)
+          node.children.unlink
+          new_children.each { |child| add_child(node, child) }
+        end
+
+        def parent(node)
+          node.parent
+        end
+
+        def next_sibling(node)
+          node.next_sibling
+        end
+
+        def previous_sibling(node)
+          node.previous_sibling
+        end
+
+        def document(node)
+          node.document
+        end
+
+        def root(document)
+          document.respond_to?(:root) ? document.root : document.children.first
+        end
+
+        def attribute_element(attr)
+          attr.parent
+        end
+
+        def attributes(element)
+          element.attributes.values
+        end
+
+        def set_attribute(element, name, value)
+          element[name.to_s] = value.to_s
+        end
+
+        def get_attribute(element, name)
+          # attributes keys don't include attribute namespaces
+          element.attributes[name.to_s]
+        end
+
+        def get_attribute_value(element, name)
+          # get the attribute value by its name including a namespace
+          element[name.to_s]
+        end
+
+        def remove_attribute(element, name)
+          element.remove_attribute(name.to_s)
+        end
+
+        def add_child(element, child)
+          if node_type(child) == :doctype
+            # avoid exceptions: cannot reparent Nokogiri::XML::DTD there
+            element.create_internal_subset(
+              child.name, child.external_id, child.system_id
+            )
+          else
+            element.add_child(child)
+          end
+        end
+
+        def add_previous_sibling(node, sibling)
+          node.add_previous_sibling(sibling)
+        end
+
+        def add_next_sibling(node, sibling)
+          node.add_next_sibling(sibling)
+        end
+
+        def remove(node)
+          node.remove
+        end
+
+        def replace(node, new_node)
+          node.replace(new_node)
+        end
+
+        def text_content(node)
+          node.content
+        end
+
+        def set_text_content(node, content)
+          node.native_content = content
+        end
+
+        def cdata_content(node)
+          node.content
+        end
+
+        def set_cdata_content(node, content)
+          node.content = content
+        end
+
+        def comment_content(node)
+          node.content
+        end
+
+        def set_comment_content(node, content)
+          node.native_content = content
+        end
+
+        def processing_instruction_content(node)
+          node.content
+        end
+
+        def set_processing_instruction_content(node, content)
+          node.native_content = content
+        end
+
+        def namespace_prefix(namespace)
+          namespace.prefix
+        end
+
+        def namespace_uri(namespace)
+          namespace.href
+        end
+
+        def namespace_definitions(node)
+          node.namespace_definitions
+        end
+
+        def xpath(node, expression, namespaces = nil)
+          node.xpath(expression, namespaces).to_a
+        rescue ::Nokogiri::XML::XPath::SyntaxError => e
+          raise Moxml::XPathError, e.message
+        end
+
+        def at_xpath(node, expression, namespaces = nil)
+          node.at_xpath(expression, namespaces)
+        rescue ::Nokogiri::XML::XPath::SyntaxError => e
+          raise Moxml::XPathError, e.message
+        end
+
+        def serialize(node, options = {})
+          save_options = ::Nokogiri::XML::Node::SaveOptions::AS_XML
+
+          # Don't force expand empty elements if they're really empty
+          save_options |= ::Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS if options[:expand_empty]
+          save_options |= ::Nokogiri::XML::Node::SaveOptions::FORMAT if options[:indent].to_i.positive?
+          save_options |= ::Nokogiri::XML::Node::SaveOptions::NO_DECLARATION if options[:no_declaration]
+
+          node.to_xml(
+            indent: options[:indent],
+            encoding: options[:encoding],
+            save_with: save_options
+          )
+        end
+
+        private
+
+        def build_declaration_attrs(version, encoding, standalone)
+          attrs = { "version" => version }
+          attrs["encoding"] = encoding if encoding
+          attrs["standalone"] = standalone if standalone
+          attrs.map { |k, v| %(#{k}="#{v}") }.join(" ")
+        end
+
+        def current_declaration_attributes(declaration)
+          ::Moxml::Declaration::ALLOWED_ATTRIBUTES.inject({}) do |hsh, attr_name|
+            value = declaration_attribute(declaration, attr_name)
+            next hsh if value.nil?
+
+            hsh.merge(attr_name => value)
+          end
+        end
+      end
+    end
+  end
+end