moxml 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aeebdab58434af19ecef2aef1d8be83f44aa4cafef5386cc01f90df9c0d74b0
-  data.tar.gz: 365ea23544a86eb5fbe13d6c87a903c844db321ba7884521ba76c4f169558bd2
+  metadata.gz: 90a6a09c55ff15198efd4687fa31e58bc4b17fa6a72b46c0e9cb88d5474f8899
+  data.tar.gz: 27b376ff3bfa49b2bcb7c768451af8e39f491a7e2467c6965e85cee3cedc43f9
 SHA512:
-  metadata.gz: 924f7a2e7e6a68d9e78f4f65244bd5f8cdaefa58c00dc7a3a926d2cb41d1d6ac39cc98c46cdd83f13dbdec450ad5b8abbe400c6b89a595aadf2e1c21f074ab01
-  data.tar.gz: f125a15ea901391a648a3545b5afa79d9e3794c4e5f4009c6cca623501ad53071f27fbc3046da7fe0a964a240c8d9ae7f75410283f59daa0b6a34ac561540c68
+  metadata.gz: 3895bfc0612eddea337e083e6cdd66dbfda811d7d819c858d05a7e30b433c226ddaa8e7995690c65f142b329ac9454c8712c1cb9f6d95372c8cbbc0b0c8e7846
+  data.tar.gz: 52bf943812996dcd501d65dfe2d6f9b06578429de92fe2ad74f87080c1c57cc04a8574c3e85ad72f156918d5ada2415c8e4a4c5e97ff2f10d68b5056d821c599

data/.gitignore

@@ -1,4 +1,3 @@
-/.bundle/
 /.yardoc
 /_yardoc/
 /coverage/

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-07 04:56:30 UTC using RuboCop version 1.71.2.
+# 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: 49
+# 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: 373
 
-# 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: 16
+
+# 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,17 +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: 20
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
+# 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:
-    - 'spec/support/shared_examples/examples/readme_examples.rb'
+    - 'lib/moxml/adapter/customized_rexml/formatter.rb'
+    - 'lib/moxml/adapter/rexml.rb'

data/Gemfile

@@ -11,9 +11,12 @@ 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"
+#  Provides iteration per second benchmarking for Ruby
+gem "benchmark-ips"
 
 # Needed by get_process_mem on Windows
 gem "sys-proctable" if Gem.win_platform?

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,80 @@ Key features:
 * Easy switching between XML processing engines
 * Clean separation between interface and implementation
 
+== Supported XML libraries
+
+Moxml supports the following XML libraries:
+
+REXML:: https://github.com/ruby/rexml[REXML], a pure Ruby XML parser
+distributed with standard Ruby. Not the fastest, but always available.
+
+Nokogiri:: (default) 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.
+
+=== Feature table
+
+Moxml exercises its best effort to provide a consistent interface across basic
+XML features, various XML libraries have different features and capabilities.
+
+The following table summarizes the features supported by each library.
+
+NOTE: The checkmarks indicate support for the feature, while the footnotes
+provide additional context for specific features.
+
+[cols="1,1,1,1,3"]
+|===
+|Feature |Nokogiri |Oga |REXML |Ox
+
+|Parsing, serializing
+| ✅
+| ✅
+| ✅
+| ✅
+
+|Node manipulation
+| ✅
+| ✅
+| ✅
+| ✅ See NOTE 1.
+
+|Basic XPath
+| ✅
+| ✅
+| ✅
+a|
+Uses `locate`. See NOTE 2.
+
+|XPath with namespaces
+| ✅
+| ✅
+| ❌
+a|
+Uses `locate`. See NOTE 2.
+
+|===
+
+NOTE 1: Ox's node manipulation may have issues, especially when manipulating Text nodes.
+
+NOTE 2: The native Ox method `locate` is similar to XPath but has a different syntax.
+
 == Getting started
 
+=== Installation
+
 Install the gem and at least one supported XML library:
 
 [source,ruby]
 ----
 # In your Gemfile
 gem 'moxml'
-gem 'nokogiri'  # Or 'oga', or 'ox' when it is integrated
+gem 'nokogiri'  # Or 'oga', 'rexml', or 'ox'
 ----
 
 === Basic document creation
@@ -228,7 +293,7 @@ text.text?              # Returns true
 
 # Structure
 text.parent             # Get parent node
-text.remove            # Remove from document
+text.remove             # Remove from document
 text.replace(node)      # Replace with another node
 ----
 
@@ -250,7 +315,7 @@ cdata.cdata?           # Returns true
 
 # Structure
 cdata.parent           # Get parent node
-cdata.remove          # Remove from document
+cdata.remove           # Remove from document
 cdata.replace(node)    # Replace with another node
 ----
 
@@ -289,7 +354,7 @@ pi = doc.create_processing_instruction("xml-stylesheet",
 # PI properties
 pi.target              # Get PI target
 pi.target = "new"      # Set PI target
-pi.content            # Get PI content
+pi.content             # Get PI content
 pi.content = "new"     # Set PI content
 
 # Node type checking
@@ -297,7 +362,7 @@ pi.processing_instruction? # Returns true
 
 # Structure
 pi.parent             # Get parent node
-pi.remove            # Remove from document
+pi.remove             # Remove from document
 pi.replace(node)      # Replace with another node
 ----
 
@@ -344,15 +409,13 @@ Each node type provides methods for traversing the document structure:
 
 [source,ruby]
 ----
-node.parent               # Get parent node
+node.parent              # Get parent node
 node.children            # Get child nodes
 node.next_sibling        # Get next sibling
 node.previous_sibling    # Get previous sibling
-node.ancestors           # Get all ancestor nodes
-node.descendants         # Get all descendant nodes
 
 # Type checking
-node.element?           # Is it an element?
+node.element?          # Is it an element?
 node.text?             # Is it a text node?
 node.cdata?            # Is it a CDATA section?
 node.comment?          # Is it a comment?
@@ -362,14 +425,14 @@ node.namespace?        # Is it a namespace?
 
 # Node information
 node.document          # Get owning document
-node.path              # Get XPath to node
-node.line_number       # Get source line number (if available)
 ----
 
 == Advanced features
 
 === XPath querying and node mapping
 
+==== Nokogiri, Oga, REXML
+
 Moxml provides efficient XPath querying by leveraging the native XML library's
 implementation while maintaining consistent node mapping:
 
@@ -394,6 +457,12 @@ doc.xpath('//book').each do |book|
 end
 ----
 
+==== Ox
+
+The native Ox's query method
+https://www.ohler.com/ox/Ox/Element.html#method-i-locate[`locate`] resembles
+XPath but has a different syntax.
+
 === Namespace handling
 
 [source,ruby]
@@ -478,22 +547,23 @@ end
 
 === Default adapter selection
 
-To use an adapter other than `:nokogiri` as the global default, set it before
-processing any input using the following option.
+To select a non-default adapter, set it before processing any input using the
+following syntax.
 
 [source,ruby]
 ----
 Moxml::Config.default_adapter = <adapter-symbol>
 ----
 
-Moxml supports the following adapters:
+Where, `<adapter-symbol>` is one of the following:
 
-`:nokogiri`:: (default) https://github.com/sparklemotion/nokogiri[Nokogiri], a
-wrapper around the https://github.com/GNOME/libxml2[libxml2] C library
+`:rexml`:: REXML
 
-`:oga`:: https://github.com/yorickpeterse/oga[Oga], a pure Ruby XML parser
+`:nokogiri`:: Nokogiri (default)
 
-`:ox`:: https://github.com/ohler55/ox[Ox], a fast XML parser (not yet supported)
+`:oga`:: Oga
+
+`:ox`:: Ox
 
 
 == Thread safety
@@ -546,7 +616,7 @@ doc.xpath('//book/title')
 doc.xpath('//title')
 
 # Most efficient - direct child access
-root.xpath('./title')
+root.xpath('./*/title')
 ----
 
 == Best practices
@@ -556,7 +626,7 @@ root.xpath('./title')
 [source,ruby]
 ----
 # Preferred - using builder pattern
-doc = Moxml.new.build do
+doc = Moxml::Builder.new(Moxml.new).build do
   declaration version: "1.0", encoding: "UTF-8"
   element 'root' do
     element 'child' do
@@ -567,7 +637,7 @@ end
 
 # Alternative - direct manipulation
 doc = Moxml.new.create_document
-doc.add_declaration(version: "1.0", encoding: "UTF-8")
+doc.add_child(doc.create_declaration("1.0", "UTF-8"))
 root = doc.create_element('root')
 doc.add_child(root)
 ----
@@ -583,6 +653,7 @@ element
 
 # Preferred - clear node type checking
 if node.element?
+  node.add_namespace('dc', 'http://purl.org/dc/elements/1.1/')
   node.add_child(doc.create_text('content'))
 end
 ----
@@ -597,7 +668,8 @@ end
 
 == License
 
-Copyright (c) 2024 Ribose Inc.
+Copyright Ribose.
 
-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

@@ -19,7 +19,7 @@ module Moxml
           raise NotImplementedError
         end
 
-        def create_document
+        def create_document(native_doc = nil)
           raise NotImplementedError
         end
 
@@ -29,7 +29,8 @@ module Moxml
         end
 
         def create_text(content)
-          create_native_text(normalize_xml_value(content))
+          # Ox freezes the content, so we need to dup it
+          create_native_text(normalize_xml_value(content).dup)
         end
 
         def create_cdata(content)
@@ -63,6 +64,23 @@ 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
+
+        def patch_node(node, _parent = nil)
+          # monkey-patch the native node if necessary
+          node
+        end
+
         protected
 
         def create_native_element(name)

data/lib/moxml/adapter/customized_ox/attribute.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../../../ox/node"
+
+module Moxml
+  module Adapter
+    module CustomizedOx
+      class Attribute < ::Ox::Node
+        attr_reader :name, :prefix
+
+        def initialize(attr_name, value, parent = nil)
+          self.name = attr_name
+          @parent = parent
+          super(value)
+        end
+
+        def name=(new_name)
+          @prefix, new_name = new_name.to_s.split(":", 2) if new_name.to_s.include?(":")
+
+          @name = new_name
+        end
+
+        def expanded_name
+          [prefix, name].compact.join(":")
+        end
+      end
+    end
+  end
+end

data/lib/moxml/adapter/customized_ox/namespace.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../../ox/node"
+
+module Moxml
+  module Adapter
+    module CustomizedOx
+      class Namespace
+        attr_accessor :uri, :parent
+        attr_writer :prefix
+
+        def initialize(prefix, uri, parent = nil)
+          @prefix = prefix
+          @uri = uri
+          @parent = parent
+        end
+
+        def prefix
+          return if @prefix == "xmlns" || @prefix.nil?
+
+          @prefix.to_s.delete_prefix("xmlns:")
+        end
+
+        def expanded_prefix
+          ["xmlns", prefix].compact.join(":")
+        end
+
+        def default?
+          prefix.nil?
+        end
+      end
+    end
+  end
+end

data/lib/moxml/adapter/customized_ox/text.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "../../../ox/node"
+
+module Moxml
+  module Adapter
+    module CustomizedOx
+      # Ox uses Strings, but a string cannot have a parent reference
+      class Text < ::Ox::Node; end
+    end
+  end
+end