moxml 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 590ee539c3419cf7c36cbd58a031a0939f2e6fc87637509c012292b3d8b09ebd
-  data.tar.gz: 5452e3fc378dbff7ab557dfae51553b287dbca33f2ddd07db38728ccf1e01a16
+  metadata.gz: 7aeebdab58434af19ecef2aef1d8be83f44aa4cafef5386cc01f90df9c0d74b0
+  data.tar.gz: 365ea23544a86eb5fbe13d6c87a903c844db321ba7884521ba76c4f169558bd2
 SHA512:
-  metadata.gz: 95cc452d7d28c352589a036c6a2a2aff8496e020c77b61da797d962a656466ca770480d94288af538fd541eba6b2d031e1d6b3ee9cb8c12b62da471f03258be4
-  data.tar.gz: 54dcff1b9875e3344d42a2cdaca136511d163d92b8303785b495a84b0c2dfcb7c9ea3853fc65c0b8a926d9ad0c00651fd0edd02be4d9db8980fd4171c6197418
+  metadata.gz: 924f7a2e7e6a68d9e78f4f65244bd5f8cdaefa58c00dc7a3a926d2cb41d1d6ac39cc98c46cdd83f13dbdec450ad5b8abbe400c6b89a595aadf2e1c21f074ab01
+  data.tar.gz: f125a15ea901391a648a3545b5afa79d9e3794c4e5f4009c6cca623501ad53071f27fbc3046da7fe0a964a240c8d9ae7f75410283f59daa0b6a34ac561540c68

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-02-07 04:56:30 UTC using RuboCop version 1.71.2.
 # 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
@@ -28,7 +28,7 @@ Lint/MissingSuper:
 Metrics/AbcSize:
   Max: 30
 
-# Offense count: 46
+# Offense count: 49
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
@@ -63,3 +63,11 @@ Naming/MethodParameterName:
 # 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:
+  Exclude:
+    - 'spec/support/shared_examples/examples/readme_examples.rb'

data/README.adoc

@@ -32,7 +32,7 @@ Install the gem and at least one supported XML library:
 ----
 # In your Gemfile
 gem 'moxml'
-gem 'nokogiri'  # Or 'ox' or 'oga'
+gem 'nokogiri'  # Or 'oga', or 'ox' when it is integrated
 ----
 
 === Basic document creation
@@ -45,7 +45,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 +69,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 +98,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 +132,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 +173,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 +445,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 +456,9 @@ end
 
 == Configuration
 
-Moxml can be configured globally or per instance:
+=== General
+
+Moxml can be configured globally or per instance.
 
 [source,ruby]
 ----
@@ -465,11 +471,31 @@ end
 
 # Instance configuration
 moxml = Moxml.new do |config|
-  config.adapter = :ox
+  config.adapter = :oga
   config.strict = false
 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.
+
+[source,ruby]
+----
+Moxml::Config.default_adapter = <adapter-symbol>
+----
+
+Moxml supports the following adapters:
+
+`:nokogiri`:: (default) https://github.com/sparklemotion/nokogiri[Nokogiri], a
+wrapper around the https://github.com/GNOME/libxml2[libxml2] C library
+
+`:oga`:: https://github.com/yorickpeterse/oga[Oga], a pure Ruby XML parser
+
+`:ox`:: https://github.com/ohler55/ox[Ox], a fast XML parser (not yet supported)
+
+
 == Thread safety
 
 Moxml is thread-safe when used properly. Each instance maintains its own state
@@ -563,11 +589,11 @@ 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
 

data/lib/moxml/config.rb

@@ -6,8 +6,14 @@ module Moxml
     DEFAULT_ADAPTER = VALID_ADAPTERS.first
 
     class << self
+      attr_writer :default_adapter
+
       def default
-        @default ||= new(DEFAULT_ADAPTER, true, "UTF-8")
+        @default ||= new(default_adapter, true, "UTF-8")
+      end
+
+      def default_adapter
+        @default_adapter ||= DEFAULT_ADAPTER
       end
     end
 
@@ -38,7 +44,10 @@ module Moxml
       adapter
     end
 
-    alias default_adapter= adapter=
+    def default_adapter=(name)
+      self.adapter = name
+      self.class.default_adapter = name
+    end
 
     def adapter
       @adapter ||= Adapter.load(@adapter_name)

data/lib/moxml/element.rb

@@ -83,11 +83,11 @@ module Moxml
       adapter.inner_text(@native)
     end
 
-    def inner_html
-      adapter.inner_html(@native)
+    def inner_xml
+      adapter.inner_xml(@native)
     end
 
-    def inner_html=(html)
+    def inner_xml=(html)
       doc = context.parse("<root>#{html}</root>")
       adapter.replace_children(@native, doc.root.children.map(&:native))
     end

data/lib/moxml/version.rb

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

data/spec/moxml_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Moxml do
 
     it "uses configured options from the block" do
       Moxml.configure do |config|
-        config.adapter = :oga
+        config.default_adapter = :oga
         config.strict_parsing = false
         config.default_encoding = "US-ASCII"
       end

data/spec/support/shared_examples/element.rb

@@ -79,8 +79,8 @@ RSpec.shared_examples "Moxml::Element" do
         expect(element.text).to eq("firstsecond")
       end
 
-      it "sets inner HTML" do
-        element.inner_html = "<child>text</child>"
+      it "sets inner XML" do
+        element.inner_xml = "<child>text</child>"
         expect(element.children.size).to eq(1)
         expect(element.children.first.name).to eq("child")
         expect(element.children.first.text).to eq("text")

data/spec/support/shared_examples/examples/readme_examples.rb

@@ -1,20 +1,25 @@
 # frozen_string_literal: true
 
 RSpec.shared_examples "README Examples" do
-  describe "Quick Start example" do
+  describe "Basic document creation" do
     it "builds document as shown in README" do
-      context = Moxml.new
-      doc = context.create_document
+      doc = Moxml.new.create_document
+
+      # Add XML declaration
+      doc.add_child(doc.create_declaration("1.0", "UTF-8"))
 
+      # Create root element with namespace
       root = doc.create_element("book")
+      root.add_namespace("dc", "http://purl.org/dc/elements/1.1/")
       doc.add_child(root)
 
-      root.add_namespace("dc", "http://purl.org/dc/elements/1.1/")
+      # Add content
       title = doc.create_element("dc:title")
-      title.add_child(doc.create_text("XML Processing with Ruby"))
+      title.text = "XML Processing with Ruby"
       root.add_child(title)
 
       expect(doc.to_xml).to include(
+        '<?xml version="1.0" encoding="UTF-8"?>',
         '<book xmlns:dc="http://purl.org/dc/elements/1.1/">',
         "<dc:title>XML Processing with Ruby</dc:title>",
         "</book>"
@@ -22,7 +27,42 @@ RSpec.shared_examples "README Examples" do
     end
   end
 
-  describe "Complex document example" do
+  describe "Using the builder pattern" do
+    it "builds a correct document" do
+      doc = Moxml::Builder.new(Moxml.new).build do
+        declaration version: "1.0", encoding: "UTF-8"
+
+        element "library", xmlns: "http://example.org/library" do
+          element "book" do
+            element "title" do
+              text "Ruby Programming"
+            end
+
+            element "author" do
+              text "Jane Smith"
+            end
+
+            comment "Publication details"
+            element "published", year: "2024"
+
+            cdata "<custom>metadata</custom>"
+          end
+        end
+      end
+
+      expect(doc.to_xml).to include(
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        '<library xmlns="http://example.org/library">',
+        "<title>Ruby Programming</title>",
+        "<!--Publication details-->",
+        '<published year="2024"></published>',
+        "<![CDATA[<custom>metadata</custom>]]>",
+        "</book>"
+      )
+    end
+  end
+
+  describe "Direct document manipulation" do
     it "builds document with all features" do
       doc = Moxml.new.create_document
 
@@ -38,10 +78,12 @@ RSpec.shared_examples "README Examples" do
       # Add books
       %w[Ruby XML].each do |title|
         book = doc.create_element("book")
+        book["id"] = "b1-#{title}"
 
-        # Add metadata
+        # Add mixed content
+        book.add_child(doc.create_comment("Book details"))
         dc_title = doc.create_element("dc:title")
-        dc_title.add_child(doc.create_text(title))
+        dc_title.text = title
         book.add_child(dc_title)
 
         # Add description
@@ -52,13 +94,16 @@ RSpec.shared_examples "README Examples" do
         root.add_child(book)
       end
 
-      xml = doc.to_xml
-      expect(xml).to include('<?xml version="1.0" encoding="UTF-8"?>')
-      expect(xml).to include('<library xmlns="http://example.org/library" xmlns:dc="http://purl.org/dc/elements/1.1/">')
-      expect(xml).to include("<dc:title>Ruby</dc:title>")
-      expect(xml).to include("<![CDATA[About Ruby...]]>")
-      expect(xml).to include("<dc:title>XML</dc:title>")
-      expect(xml).to include("<![CDATA[About XML...]]>")
+      expect(doc.to_xml).to include(
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        '<library xmlns="http://example.org/library" xmlns:dc="http://purl.org/dc/elements/1.1/">',
+        '<book id="b1-Ruby">',
+        "<!--Book details-->",
+        "<dc:title>Ruby</dc:title>",
+        "<![CDATA[About Ruby...]]>",
+        "<dc:title>XML</dc:title>",
+        "<![CDATA[About XML...]]>"
+      )
     end
   end
 
@@ -70,6 +115,18 @@ RSpec.shared_examples "README Examples" do
         context.parse("<invalid>")
       end.to raise_error(Moxml::ParseError)
 
+      expect do
+        doc = context.parse("<root/>")
+        root = doc.root
+        root.add_namespace("n", "wrong.url")
+      end.to raise_error(Moxml::NamespaceError)
+
+      expect do
+        doc = context.parse("<root/>")
+        element = doc.create_element("wrong,name")
+        doc.add_child(element)
+      end.to raise_error(Moxml::ValidationError)
+
       doc = context.parse("<root/>")
       expect do
         doc.xpath("///")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxml
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies: []
 description: 'Moxml is a unified XML manipulation library that provides a common API.