moxml 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 590ee539c3419cf7c36cbd58a031a0939f2e6fc87637509c012292b3d8b09ebd
-  data.tar.gz: 5452e3fc378dbff7ab557dfae51553b287dbca33f2ddd07db38728ccf1e01a16
+  metadata.gz: 65fadaecfecbc8142d11c82c79c20ea9811e3b58e21b94f335ba822bdfbfc852
+  data.tar.gz: e0189194a594ff763ffec269d15e56dadf91b22369d2efb399e29e3c993f1ace
 SHA512:
-  metadata.gz: 95cc452d7d28c352589a036c6a2a2aff8496e020c77b61da797d962a656466ca770480d94288af538fd541eba6b2d031e1d6b3ee9cb8c12b62da471f03258be4
-  data.tar.gz: 54dcff1b9875e3344d42a2cdaca136511d163d92b8303785b495a84b0c2dfcb7c9ea3853fc65c0b8a926d9ad0c00651fd0edd02be4d9db8980fd4171c6197418
+  metadata.gz: 6c20b0290ed6a6f9ea904564b7619c05f1aec9b9ebe9274a6ea042b9756caeb8792a4d6f45224af8019e2760b8d752ff20a9ef9c4f8f4acb893be069b7f95a92
+  data.tar.gz: 05d046559db87598410f122e51fa7a2276d975f40eabe19f32c65de6c2459238976551496937e33a2a319e3a7ff110bdc782af8ce9942bfcc24840f292d79150

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-13 02:38:07 UTC using RuboCop version 1.70.0.
+# on 2025-05-09 11:52:41 UTC using RuboCop version 1.68.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -17,39 +17,45 @@ Lint/MissingCopEnableDirective:
   Exclude:
     - 'lib/moxml/adapter/customized_oga/xml_generator.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: AllowedParentClasses.
 Lint/MissingSuper:
   Exclude:
     - 'lib/moxml/adapter/customized_oga/xml_declaration.rb'
+    - 'lib/moxml/adapter/customized_rexml/formatter.rb'
 
-# Offense count: 5
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 30
+  Max: 39
 
-# Offense count: 46
+# Offense count: 53
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 152
+  Max: 270
 
-# Offense count: 3
+# Offense count: 5
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 246
+  Max: 335
 
-# Offense count: 3
+# Offense count: 7
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 15
 
-# Offense count: 9
+# Offense count: 15
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 20
+  Max: 23
 
-# Offense count: 4
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 15
+
+# Offense count: 5
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
@@ -57,9 +63,39 @@ Naming/MethodParameterName:
     - 'lib/moxml/adapter/customized_oga/xml_generator.rb'
     - 'lib/moxml/adapter/nokogiri.rb'
     - 'lib/moxml/adapter/ox.rb'
+    - 'lib/moxml/adapter/rexml.rb'
     - 'lib/moxml/attribute.rb'
 
-# Offense count: 27
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CombinableLoops:
+  Exclude:
+    - 'lib/moxml/adapter/customized_rexml/formatter.rb'
+
+# Offense count: 28
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'lib/moxml/adapter/customized_rexml/formatter.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBranchesCount.
+Style/HashLikeCase:
+  Exclude:
+    - 'lib/moxml/adapter/customized_rexml/formatter.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/moxml/adapter/customized_rexml/formatter.rb'
+    - 'lib/moxml/adapter/rexml.rb'

data/Gemfile

@@ -11,6 +11,7 @@ gem "nokogiri", "~> 1.15"
 gem "oga", "~> 3.4"
 gem "ox", "~> 2.14"
 gem "rake", "~> 13"
+gem "rexml"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "tempfile", "~> 0.3"

data/LICENSE.md

@@ -0,0 +1,33 @@
+Licenses & Copyright
+====================
+
+This license file adheres to the formatting guidelines of
+[readable-licenses](https://github.com/nevir/readable-licenses).
+
+
+Ribose's BSD 2-Clause License
+-----------------------------
+
+Copyright (c) 2024, [Ribose Inc](https://www.ribose.com).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1.  Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+2.  Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -24,15 +24,35 @@ Key features:
 * Easy switching between XML processing engines
 * Clean separation between interface and implementation
 
+== Supported XML libraries
+
+Moxml supports the following XML libraries:
+
+REXML:: (default) https://github.com/ruby/rexml[REXML], a pure Ruby XML parser
+distributed with standard Ruby. Not the fastest, but always available.
+
+Nokogiri:: (recommended) https://github.com/sparklemotion/nokogiri[Nokogiri], a
+widely used implementation which wraps around the performant
+https://github.com/GNOME/libxml2[libxml2] C library.
+
+Oga:: https://github.com/yorickpeterse/oga[Oga], a pure Ruby XML parser.
+Recommended when you need a pure Ruby solution say for
+https://github.com/opal/opal[Opal].
+
+Ox:: https://github.com/ohler55/ox[Ox], a fast XML parser (to be supported)
+
+
 == Getting started
 
+=== Installation
+
 Install the gem and at least one supported XML library:
 
 [source,ruby]
 ----
 # In your Gemfile
 gem 'moxml'
-gem 'nokogiri'  # Or 'ox' or 'oga'
+gem 'nokogiri'  # Or 'oga', 'rexml', or 'ox' when it is integrated
 ----
 
 === Basic document creation
@@ -45,7 +65,7 @@ require 'moxml'
 doc = Moxml.new.create_document
 
 # Add XML declaration
-doc.add_declaration(version: "1.0", encoding: "UTF-8")
+doc.add_child(doc.create_declaration("1.0", "UTF-8"))
 
 # Create root element with namespace
 root = doc.create_element('book')
@@ -69,7 +89,7 @@ The builder pattern provides a clean DSL for creating XML documents:
 
 [source,ruby]
 ----
-doc = Moxml.new.build do
+doc = Moxml::Builder.new(Moxml.new).build do
   declaration version: "1.0", encoding: "UTF-8"
 
   element 'library', xmlns: 'http://example.org/library' do
@@ -98,11 +118,12 @@ end
 doc = Moxml.new.create_document
 
 # Add declaration
-doc.add_declaration(version: "1.0", encoding: "UTF-8")
+doc.add_child(doc.create_declaration("1.0", "UTF-8"))
 
 # Create root with namespace
 root = doc.create_element('library')
 root.add_namespace(nil, 'http://example.org/library')
+root.add_namespace("dc", "http://purl.org/dc/elements/1.1/")
 doc.add_child(root)
 
 # Add elements with attributes
@@ -131,23 +152,23 @@ doc = Moxml.new.create_document
 doc = Moxml.new.parse(xml_string)
 
 # Document properties and methods
-doc.encoding                # Get document encoding
-doc.encoding = "UTF-8"      # Set document encoding
+doc.encoding               # Get document encoding
+doc.encoding = "UTF-8"     # Set document encoding
 doc.version                # Get XML version
 doc.version = "1.1"        # Set XML version
 doc.standalone             # Get standalone declaration
 doc.standalone = "yes"     # Set standalone declaration
 
 # Document structure
-doc.root                   # Get root element
+doc.root                  # Get root element
 doc.children              # Get all top-level nodes
 doc.add_child(node)       # Add a child node
 doc.remove_child(node)    # Remove a child node
 
 # Node creation methods
-doc.create_element(name)   # Create new element
-doc.create_text(content)   # Create text node
-doc.create_cdata(content)  # Create CDATA section
+doc.create_element(name)    # Create new element
+doc.create_text(content)    # Create text node
+doc.create_cdata(content)   # Create CDATA section
 doc.create_comment(content) # Create comment
 doc.create_processing_instruction(target, content) # Create PI
 
@@ -172,8 +193,8 @@ element.name = "new_name"  # Set element name
 element.text              # Get text content
 element.text = "content"   # Set text content
 element.inner_text        # Get text content for current node only
-element.inner_html        # Get inner XML content
-element.inner_html = xml   # Set inner XML content
+element.inner_xml         # Get inner XML content
+element.inner_xml = xml   # Set inner XML content
 
 # Attributes
 element[name]             # Get attribute value
@@ -444,6 +465,9 @@ rescue Moxml::ValidationError => e
 rescue Moxml::XPathError => e
   # Handles XPath expression errors
   puts "XPath error: #{e.message}"
+rescue Moxml::NamespaceError => e
+  # Handles namespace errors
+  puts "Namespace error: #{e.message}"
 rescue Moxml::Error => e
   # Handles other Moxml-specific errors
   puts "Error: #{e.message}"
@@ -452,7 +476,9 @@ end
 
 == Configuration
 
-Moxml can be configured globally or per instance:
+=== General
+
+Moxml can be configured globally or per instance.
 
 [source,ruby]
 ----
@@ -465,11 +491,32 @@ end
 
 # Instance configuration
 moxml = Moxml.new do |config|
-  config.adapter = :ox
+  config.adapter = :oga
   config.strict = false
 end
 ----
 
+=== Default adapter selection
+
+To select a non-default adapter, set it before processing any input using the
+following syntax.
+
+[source,ruby]
+----
+Moxml::Config.default_adapter = <adapter-symbol>
+----
+
+Where, `<adapter-symbol>` is one of the following:
+
+`:rexml`:: REXML (default)
+
+`:nokogiri`:: Nokogiri
+
+`:oga`:: Oga
+
+`:ox`:: Ox (not yet supported)
+
+
 == Thread safety
 
 Moxml is thread-safe when used properly. Each instance maintains its own state
@@ -563,15 +610,16 @@ end
 
 == Contributing
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin feature/my-new-feature`)
-5. Create a new Pull Request
+. Fork the repository
+. Create your feature branch (`git checkout -b feature/my-new-feature`)
+. Commit your changes (`git commit -am 'Add some feature'`)
+. Push to the branch (`git push origin feature/my-new-feature`)
+. Create a new Pull Request
 
 == License
 
-Copyright (c) 2024 Ribose Inc.
+Copyright (c) Ribose Inc.
 
-This project is licensed under the BSD-2-Clause License. See the LICENSE file for details.
+This project is licensed under the BSD-2-Clause License. See the
+link:LICENSE.md[] file for details.
 

data/lib/moxml/adapter/base.rb

@@ -63,6 +63,18 @@ module Moxml
           create_native_namespace(element, prefix, uri)
         end
 
+        def set_attribute_name(attribute, name)
+          attribute.name = name
+        end
+
+        def set_attribute_value(attribute, value)
+          attribute.value = value
+        end
+
+        def duplicate_node(node)
+          node.dup
+        end
+
         protected
 
         def create_native_element(name)

data/lib/moxml/adapter/customized_rexml/formatter.rb

@@ -0,0 +1,195 @@
+require "rexml/formatters/pretty"
+
+module Moxml
+  module Adapter
+    module CustomizedRexml
+      # Custom REXML formatter that fixes indentation and wrapping issues
+      class Formatter < ::REXML::Formatters::Pretty
+        def initialize(indentation: 2, self_close_empty: false)
+          @indentation = " " * indentation
+          @level = 0
+          @compact = true
+          @width = -1 # Disable line wrapping
+          @self_close_empty = self_close_empty
+        end
+
+        def write(node, output)
+          case node
+          when ::REXML::XMLDecl
+            write_declaration(node, output)
+          else
+            super
+          end
+        end
+
+        def write_element(node, output)
+          # output << ' ' * @level
+          output << "<#{node.expanded_name}"
+          write_attributes(node, output)
+
+          if node.children.empty? && @self_close_empty
+            output << "/>"
+            return
+          end
+
+          output << ">"
+
+          # Check for mixed content
+          has_text = node.children.any? { |c| c.is_a?(::REXML::Text) && !c.to_s.strip.empty? }
+          has_elements = node.children.any? { |c| c.is_a?(::REXML::Element) }
+          mixed = has_text && has_elements
+
+          # Handle children based on content type
+          unless node.children.empty?
+            @level += @indentation.length unless mixed
+
+            node.children.each_with_index do |child, _index|
+              # Skip insignificant whitespace
+              next if child.is_a?(::REXML::Text) &&
+                      child.to_s.strip.empty? &&
+                      !(child.next_sibling.nil? && child.previous_sibling.nil?)
+
+              # Indent non-text nodes in non-mixed content
+              # if !mixed && !child.is_a?(::REXML::Text)
+              #   output << ' ' * @level
+              # end
+
+              write(child, output)
+
+              # Add newlines between elements in non-mixed content
+              # if !mixed && !child.is_a?(::REXML::Text) && index < node.children.size - 1
+              #   output << "\n"
+              # end
+            end
+
+            # Reset indentation for closing tag in non-mixed content
+            unless mixed
+              @level -= @indentation.length
+              # output << ' ' * @level
+            end
+          end
+
+          output << "</#{node.expanded_name}>"
+          # output << "\n" unless mixed
+        end
+
+        def write_text(node, output)
+          text = node.value
+          return if text.empty?
+
+          output << escape_text(text)
+        end
+
+        def escape_text(text)
+          text.to_s.gsub(/[<>&]/) do |match|
+            case match
+            when "<" then "&lt;"
+            when ">" then "&gt;"
+            when "&" then "&amp;"
+            end
+          end
+        end
+
+        private
+
+        def find_significant_sibling(node, direction)
+          method = direction == :next ? :next_sibling : :previous_sibling
+          sibling = node.send(method)
+          sibling = sibling.send(method) while sibling && sibling.is_a?(::REXML::Text) && sibling.to_s.strip.empty?
+          sibling
+        end
+
+        def write_cdata(node, output)
+          # output << ' ' * @level
+          output << "<![CDATA["
+          output << node.to_s.gsub("]]>", "]]]]><![CDATA[>")
+          output << "]]>"
+          # output << "\n"
+        end
+
+        def write_comment(node, output)
+          # output << ' ' * @level
+          output << "<!--"
+          output << node.to_s
+          output << "-->"
+          # output << "\n"
+        end
+
+        def write_instruction(node, output)
+          # output << ' ' * @level
+          output << "<?"
+          output << node.target
+          output << " "
+          output << node.content if node.content
+          output << "?>"
+          # output << "\n"
+        end
+
+        def write_document(node, output)
+          node.children.each do |child|
+            write(child, output)
+            # output << "\n" unless child == node.children.last
+          end
+        end
+
+        def write_doctype(node, output)
+          output << "<!DOCTYPE "
+          output << node.name
+          output << " "
+          output << node.external_id if node.external_id
+          output << ">"
+          # output << "\n"
+        end
+
+        def write_declaration(node, output)
+          output << "<?xml"
+          output << %( version="#{node.version}") if node.version
+          output << %( encoding="#{node.encoding.to_s.upcase}") if node.writeencoding
+          output << %( standalone="#{node.standalone}") if node.standalone
+          output << "?>"
+          # output << "\n"
+        end
+
+        def write_attributes(node, output)
+          # First write namespace declarations
+          node.attributes.each do |name, attr|
+            next unless name.to_s.start_with?("xmlns:") || name.to_s == "xmlns"
+
+            name = "xmlns" if name.to_s == "xmlns:" # convert the default namespace
+            value = attr.respond_to?(:value) ? attr.value : attr
+            output << " #{name}=\"#{value}\""
+          end
+
+          # Then write regular attributes
+          node.attributes.each do |name, attr|
+            next if name.to_s.start_with?("xmlns:") || name.to_s == "xmlns"
+
+            output << " "
+            output << if attr.respond_to?(:prefix) && attr.prefix
+                        "#{attr.prefix}:#{attr.name}"
+                      else
+                        name.to_s
+                      end
+
+            output << "=\""
+            value = attr.respond_to?(:value) ? attr.value : attr
+            output << escape_attribute_value(value.to_s)
+            output << "\""
+          end
+        end
+
+        def escape_attribute_value(value)
+          value.to_s.gsub(/[<>&"]/) do |match|
+            case match
+            when "<" then "&lt;"
+            when ">" then "&gt;"
+            when "&" then "&amp;"
+            when '"' then "&quot;"
+              # when "'" then '&apos;'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moxml/adapter/nokogiri.rb

@@ -221,7 +221,7 @@ module Moxml
         end
 
         def text_content(node)
-          node.content
+          node.text
         end
 
         def inner_text(node)

data/lib/moxml/adapter/oga.rb

@@ -213,11 +213,25 @@ module Moxml
         end
 
         def add_previous_sibling(node, sibling)
-          node.before(sibling)
+          if node.parent == sibling.parent
+            # Oga doesn't manipulate children of the same parent
+            dup_sibling = node.node_set.delete(sibling)
+            index = node.node_set.index(node)
+            node.node_set.insert(index, dup_sibling)
+          else
+            node.before(sibling)
+          end
         end
 
         def add_next_sibling(node, sibling)
-          node.after(sibling)
+          if node.parent == sibling.parent
+            # Oga doesn't manipulate children of the same parent
+            dup_sibling = node.node_set.delete(sibling)
+            index = node.node_set.index(node) + 1
+            node.node_set.insert(index, dup_sibling)
+          else
+            node.after(sibling)
+          end
         end
 
         def remove(node)
@@ -229,7 +243,7 @@ module Moxml
         end
 
         def replace_children(node, new_children)
-          node.inner_text = ""
+          node.children = []
           new_children.each { |child| add_child(node, child) }
         end
 
@@ -296,14 +310,14 @@ module Moxml
           node.namespaces.values
         end
 
-        def xpath(node, expression, _namespaces = {})
-          node.xpath(expression).to_a
+        def xpath(node, expression, namespaces = nil)
+          node.xpath(expression, {}, namespaces: namespaces&.transform_keys(&:to_s)).to_a
         rescue ::LL::ParserError => e
           raise Moxml::XPathError, e.message
         end
 
-        def at_xpath(node, expression, _namespaces = {})
-          node.at_xpath(expression)
+        def at_xpath(node, expression, namespaces = nil)
+          node.at_xpath(expression, namespaces: namespaces)
         rescue ::Oga::XPath::Error => e
           raise Moxml::XPathError, e.message
         end