lutaml-model 0.8.12 → 0.8.13

data/lib/lutaml/xml/adapter/xml_serializer.rb

@@ -49,6 +49,35 @@ module Lutaml
           encoding = determine_encoding(options)
           builder_options = {}
           builder_options[:encoding] = encoding if encoding
+          builder_options[:line_ending] = options[:line_ending] if options.key?(:line_ending)
+          builder_options[:indent] = options[:indent] if options.key?(:indent)
+
+          # Pass doctype to builder for document-level insertion
+          doctype_to_use = options[:doctype] || @doctype
+          if doctype_to_use && !options[:omit_doctype]
+            builder_options[:doctype] = doctype_to_use
+          end
+
+          # Pass declaration info to builder
+          if should_include_declaration?(options)
+            builder_options[:include_declaration] = true
+            builder_options[:xml_declaration] = @xml_declaration || {}
+            if options.key?(:standalone)
+              if options[:standalone] == :preserve
+                # Keep original standalone from parsed declaration (may be nil)
+              else
+                builder_options[:xml_declaration][:standalone] = standalone_value(options[:standalone])
+              end
+            end
+            if options[:declaration].is_a?(String)
+              builder_options[:xml_declaration][:version] = options[:declaration]
+            elsif options[:declaration] == true
+              builder_options[:xml_declaration][:version] = "1.0"
+            end
+            builder_options[:xml_declaration][:encoding] = encoding if options.key?(:encoding) && encoding
+          elsif options[:encoding] && !options[:encoding].nil?
+            builder_options[:force_declaration] = true
+          end
 
           builder = self.class::BUILDER_CLASS.build(builder_options) do |xml|
             if root.is_a?(self.class::PARSED_ELEMENT_CLASS)
@@ -58,7 +87,7 @@ module Lutaml
             end
           end
 
-          finalize_adapter_xml(builder.to_xml, encoding, options)
+          builder.to_xml
         end
 
         def build_serializable_xml(xml, options)
@@ -95,6 +124,14 @@ module Lutaml
 
         private
 
+        def standalone_value(value)
+          case value
+          when true then "yes"
+          when false then "no"
+          else value.to_s
+          end
+        end
+
         def transformable_xml_element(options)
           return root if root.is_a?(Lutaml::Xml::DataModel::XmlElement)
 
@@ -183,27 +220,8 @@ module Lutaml
           options_with_original_ns
         end
 
-        def finalize_adapter_xml(xml_data, encoding, options)
-          result = ""
-          if (options[:encoding] && !options[:encoding].nil?) ||
-              should_include_declaration?(options)
-            result += generate_declaration(options)
-          end
-
-          doctype_to_use = options[:doctype] || @doctype
-          if doctype_to_use && !options[:omit_doctype]
-            result += generate_doctype_declaration(doctype_to_use)
-          end
-
-          result += xml_data
-          if encoding && result.encoding.to_s.upcase != encoding.to_s.upcase
-            result = result.encode(encoding)
-          end
-          result
-        end
-
         def text_content_for_xml(value)
-          ::Moxml::Adapter::Base.preprocess_entities(value.to_s)
+          ::Moxml.preprocess_entities(value.to_s)
         end
 
         def build_plan_node(xml, xml_element, element_node, plan: nil,
@@ -212,7 +230,9 @@ module Lutaml
           attributes = {}
 
           original_ns_uris = plan&.original_namespace_uris || {}
-          element_node.hoisted_declarations.each do |key, uri|
+          element_node.hoisted_declarations.sort_by do |prefix, _uri|
+            prefix.nil? ? "" : prefix.to_s
+          end.each do |key, uri|
             next if uri == "http://www.w3.org/XML/1998/namespace"
 
             effective_uri = if self.class.fpi?(uri)

data/lib/lutaml/xml/adapter.rb

@@ -7,6 +7,10 @@ module Lutaml
       autoload :AdapterHelpers, "#{__dir__}/adapter/adapter_helpers"
       autoload :BaseAdapter, "#{__dir__}/adapter/base_adapter"
       autoload :NamespaceData, "#{__dir__}/adapter/namespace_data"
+      autoload :XmlParser, "#{__dir__}/adapter/xml_parser"
+      autoload :XmlSerializer, "#{__dir__}/adapter/xml_serializer"
+      autoload :PlanBasedBuilder, "#{__dir__}/adapter/plan_based_builder"
+      autoload :NamespaceUriCollector, "#{__dir__}/adapter/namespace_uri_collector"
       autoload :OgaAdapter, "#{__dir__}/adapter/oga_adapter"
       Lutaml::Model::RuntimeCompatibility.autoload_native(
         self,

data/lib/lutaml/xml/builder/base.rb

@@ -7,15 +7,63 @@ module Lutaml
     module Builder
       # Base builder for XML construction using moxml.
       # All adapter-specific builders inherit from this class.
+      #
+      # The builder creates XML documents through moxml's document model.
+      # Declaration, doctype, indentation, and line endings are handled
+      # by moxml — no manual string assembly.
       class Base
         def self.build(options = {})
           context = Moxml.new(moxml_backend)
           if Lutaml::Model::RuntimeCompatibility.opal?
             context.config.namespace_validation_mode = :lenient
           end
+
+          encoding_value = options.delete(:encoding)
+          context.config.default_indent = options.delete(:indent) if options.key?(:indent)
+          context.config.default_line_ending = options.delete(:line_ending) if options.key?(:line_ending)
+
           doc = context.create_document
+
+          # Capture doctype — added after root to avoid Ox incompatibility
+          doctype = options.delete(:doctype)
+
           instance = new(doc, context, options)
+          instance.encoding = encoding_value if encoding_value
           yield(instance) if block_given?
+
+          # Add doctype before root (after build block sets root)
+          if doctype && doc.root
+            dt = doc.create_doctype(
+              doctype[:name],
+              doctype[:public_id],
+              doctype[:system_id],
+            )
+            doc.add_child(dt)
+          end
+
+          # Handle declaration — configure it on the document so moxml
+          # serializes it natively (works across all adapters)
+          xml_decl = options.delete(:xml_declaration) || {}
+          include_decl = options.delete(:include_declaration)
+          force_decl = options.delete(:force_declaration)
+
+          if include_decl
+            version = xml_decl[:version] || "1.0"
+            encoding = xml_decl[:encoding]
+            encoding ||= "UTF-8" unless xml_decl[:had_declaration]
+            standalone = xml_decl[:standalone]
+            decl = doc.create_declaration(version, encoding, standalone)
+            doc.add_child(decl)
+            instance.declaration_mode = :default
+          elsif force_decl
+            decl_encoding = encoding_value || "UTF-8"
+            decl = doc.create_declaration("1.0", decl_encoding, nil)
+            doc.add_child(decl)
+            instance.declaration_mode = :default
+          else
+            instance.declaration_mode = :none
+          end
+
           instance
         end
 
@@ -24,13 +72,15 @@ module Lutaml
           nil
         end
 
-        attr_reader :doc, :encoding
+        attr_reader :doc
+        attr_accessor :encoding, :declaration_mode
 
         def initialize(doc, context, options = {})
           @doc = doc
           @context = context
           @encoding = options[:encoding]
           @current_stack = [doc]
+          @declaration_mode = :none
         end
 
         def current_element
@@ -116,33 +166,15 @@ module Lutaml
           add_cdata(current_element, content)
         end
 
-        def to_s
+        def to_xml
           return "" unless @doc.root
 
-          # Serialize full document content (including PIs before root)
-          # Check if there are any nodes before the root element
-          doc_children = @doc.children
-          has_pi_or_comment = doc_children.any? do |child|
-            child.is_a?(Moxml::ProcessingInstruction) || child.is_a?(Moxml::Comment)
-          end
-
-          if has_pi_or_comment
-            # Serialize each top-level node individually
-            parts = doc_children.map do |child|
-              if child == @doc.root
-                child.to_xml(declaration: false, expand_empty: false)
-              else
-                child.to_xml
-              end
-            end
-            parts.join("\n")
-          else
-            @doc.root.to_xml(declaration: false, expand_empty: false)
-          end
-        end
+          result = if @declaration_mode == :none && !has_document_level_nodes?
+                     @doc.root.to_xml(declaration: false, expand_empty: false)
+                   else
+                     @doc.to_xml(declaration: @declaration_mode == :default, expand_empty: false)
+                   end
 
-        def to_xml
-          result = to_s
           result = result.encode(encoding) if encoding && result.encoding.to_s != encoding
           result
         end
@@ -158,6 +190,13 @@ module Lutaml
 
         private
 
+        def has_document_level_nodes?
+          @doc.children.any? do |child|
+            child != @doc.root &&
+              !child.is_a?(Moxml::Text)
+          end
+        end
+
         def resolve_target(element)
           element.is_a?(self.class) || element.is_a?(Base) ? element.current_element : element
         end

data/lib/lutaml/xml/builder/nokogiri.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module Lutaml
   module Xml
     module Builder

data/lib/lutaml/xml/builder/oga.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module Lutaml
   module Xml
     module Builder

data/lib/lutaml/xml/builder/ox.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module Lutaml
   module Xml
     module Builder

data/lib/lutaml/xml/builder/rexml.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base"
-
 module Lutaml
   module Xml
     module Builder

data/lib/lutaml/xml/builder.rb

@@ -4,6 +4,7 @@ module Lutaml
   module Xml
     # Builder module for XML generation
     module Builder
+      autoload :Base, "#{__dir__}/builder/base"
       autoload :Oga, "#{__dir__}/builder/oga"
       Lutaml::Model::RuntimeCompatibility.autoload_native(
         self,

data/lib/lutaml/xml/configurable.rb

@@ -13,7 +13,7 @@ module Lutaml
     #     include Lutaml::Xml::Configurable
     #
     #     xml do
-    #       root 'MyModel'
+    #       element "MyModel"
     #       namespace MyNamespace
     #     end
     #   end
@@ -51,7 +51,7 @@ module Lutaml
         #
         #   @example Configuration with block
         #     xml do
-        #       root 'MyModel'
+        #       element "MyModel"
         #       namespace MyNamespace
         #       map_element 'name', to: :name
         #     end

data/lib/lutaml/xml/declaration_handler.rb

@@ -1,10 +1,9 @@
 module Lutaml
   module Xml
-    # DeclarationHandler provides XML declaration and DOCTYPE handling
-    # for all XML adapter implementations.
+    # DeclarationHandler provides XML declaration extraction from input XML.
     #
-    # This module implements Issue #1: XML Declaration Preservation
-    # across Nokogiri, Oga, and Ox adapters.
+    # Extraction methods detect and parse XML declarations from input strings.
+    # Generation is handled by moxml's document model — no manual string assembly.
     module DeclarationHandler
       # Extract XML declaration information from input string
       #
@@ -92,126 +91,25 @@ module Lutaml
       # @param xml_declaration [Hash] extracted declaration info from input
       # @return [Boolean] true if declaration should be included
       def should_include_declaration?(options, xml_declaration = nil)
-        # Use instance variable if not provided (for adapter instance methods)
         xml_declaration ||= @xml_declaration
 
         if options.key?(:declaration)
           case options[:declaration]
           when false
-            # Explicit false: omit declaration
             false
           when true
-            # Explicit true: force include
             true
           when :preserve
-            # Preserve mode: include if input had one
             xml_declaration&.dig(:had_declaration) || false
           when String
-            # Custom version string: include
             true
           else
-            # Default: preserve from input
             xml_declaration&.dig(:had_declaration) || false
           end
         else
-          # No declaration option provided: default behavior is preserve from input
           xml_declaration&.dig(:had_declaration) || false
         end
       end
-
-      # Generate XML declaration string
-      #
-      # Uses stored declaration info if available, otherwise uses defaults.
-      # Supports custom version strings, encoding, and standalone options.
-      #
-      # @param options [Hash] serialization options
-      #   - :declaration => String for custom version, true for default
-      #   - :encoding => String or true for UTF-8
-      #   - :standalone => String ("yes"/"no"), true ("yes"), false ("no"), :preserve
-      # @param xml_declaration [Hash] extracted declaration info from input
-      # @return [String] the XML declaration (includes trailing newline)
-      def generate_declaration(options, xml_declaration = nil)
-        # Use instance variable if not provided (for adapter instance methods)
-        xml_declaration ||= @xml_declaration
-
-        # Determine version
-        # When declaration: true (force), use default 1.0 not input version
-        # When declaration: "1.x" (custom), use that string
-        # When preserving (no option or :preserve), use input version or default
-        version = if options[:declaration].is_a?(String)
-                    # Custom version string
-                    options[:declaration]
-                  elsif options[:declaration] == true
-                    # Force with default version
-                    "1.0"
-                  elsif xml_declaration&.dig(:version)
-                    # Preserve from input
-                    xml_declaration[:version]
-                  else
-                    # Default fallback
-                    "1.0"
-                  end
-
-        # Determine encoding
-        # Priority: explicit encoding option > input encoding > none
-        encoding = if options[:encoding].is_a?(String)
-                     options[:encoding]
-                   elsif options[:encoding] == true
-                     "UTF-8"
-                   elsif xml_declaration&.dig(:encoding)
-                     xml_declaration[:encoding]
-                   end
-
-        # Determine standalone
-        # Priority: explicit standalone option > input standalone > none
-        # Supported values: "yes", "no", true ("yes"), false ("no"), :preserve
-        standalone = if options.key?(:standalone)
-                       case options[:standalone]
-                       when String
-                         options[:standalone]
-                       when true
-                         "yes"
-                       when false
-                         "no"
-                       when :preserve
-                         xml_declaration&.dig(:standalone)
-                       end
-                     elsif xml_declaration&.dig(:standalone)
-                       xml_declaration[:standalone]
-                     end
-
-        declaration = "<?xml version=\"#{version}\""
-        declaration += " encoding=\"#{encoding}\"" if encoding
-        declaration += " standalone=\"#{standalone}\"" if standalone
-        declaration += "?>\n"
-        declaration
-      end
-
-      # Generate DOCTYPE declaration from doctype hash
-      #
-      # Supports both PUBLIC and SYSTEM DTDs.
-      # Format: <!DOCTYPE name PUBLIC "public_id" "system_id">
-      #         <!DOCTYPE name SYSTEM "system_id">
-      #
-      # @param doctype [Hash] the doctype information
-      #   - :name => root element name
-      #   - :public_id => public identifier (optional)
-      #   - :system_id => system identifier (optional)
-      # @return [String, nil] the DOCTYPE declaration or nil if no doctype
-      def generate_doctype_declaration(doctype)
-        return nil unless doctype
-
-        parts = ["<!DOCTYPE #{doctype[:name]}"]
-
-        if doctype[:public_id]
-          parts << %(PUBLIC "#{doctype[:public_id]}")
-          parts << %("#{doctype[:system_id]}") if doctype[:system_id]
-        elsif doctype[:system_id]
-          parts << %(SYSTEM "#{doctype[:system_id]}")
-        end
-
-        "#{parts.join(' ')}>\n"
-      end
     end
   end
 end

data/lib/lutaml/xml/mapping.rb

@@ -350,11 +350,11 @@ module Lutaml
       #   namespace :blank
       #
       # @raise [ArgumentError] if invalid arguments provided
-      # @raise [Lutaml::Model::NoRootNamespaceError] if explicitly marked as no_root
+      # @raise [Lutaml::Model::TypeOnlyNamespaceError] if explicitly marked as no_root
       def namespace(ns_class_or_symbol, _deprecated_prefix = nil)
         # Only raise error for explicitly marked no_root (using deprecated method)
         # Type-only models (no element declared) CAN have namespaces
-        raise Lutaml::Model::NoRootNamespaceError if @no_root
+        raise Lutaml::Model::TypeOnlyNamespaceError if @no_root
 
         # Warn if prefix parameter is provided
         if _deprecated_prefix
@@ -784,7 +784,7 @@ module Lutaml
       #
       # @example
       #   xml do
-      #     root "rfc"
+      #     element "rfc"
       #     map_processing_instruction "rfc", to: :pi_settings
       #   end
       #

data/lib/lutaml/xml/schema/xsd/documentation.rb

@@ -10,7 +10,7 @@ module Lutaml
           attribute :content, :string
 
           xml do
-            root "documentation"
+            element "documentation"
             namespace Lutaml::Xml::Schema::XsdNamespace
 
             map_all to: :content

data/lib/lutaml/xml/serialization/collection_ext.rb

@@ -6,7 +6,7 @@ module Lutaml
       # XML-specific overrides for Collection class methods.
       #
       # Prepended into Collection's singleton class when XML is loaded.
-      # Provides XML-specific no_root handling for collections.
+      # Provides XML-specific unwrapped collection handling.
       module CollectionExt
         # XML is a structured (tree-based) format
         def collection_structured_format?(format)
@@ -15,15 +15,15 @@ module Lutaml
           true
         end
 
-        # XML handles no_root serialization specially
-        def collection_no_root_to?(format)
+        # XML handles unwrapped serialization specially
+        def collection_unwrapped_to?(format)
           return super unless format == :xml
 
           true
         end
 
-        # XML no_root serialization: serialize each mapping separately
-        def collection_no_root_to(format, mappings, instance, options)
+        # XML unwrapped serialization: serialize each mapping separately
+        def collection_unwrapped_to(format, mappings, instance, options)
           return super unless format == :xml
 
           mappings.mappings.map do |mapping|
@@ -31,8 +31,8 @@ module Lutaml
           end.join("\n")
         end
 
-        # XML no_root: wrap raw XML in a fake root tag before parsing
-        def wrap_no_root_input(format, mappings, data)
+        # XML unwrapped: wrap raw XML in a fake root tag before parsing
+        def wrap_unwrapped_input(format, mappings, data)
           return super unless format == :xml
 
           tag_name = mappings.find_by_to!(instance_name).name

data/lib/lutaml/xml/serialization/format_conversion.rb

@@ -94,7 +94,7 @@ module Lutaml
           return super unless format == :xml
 
           valid = root?(register) || options[:from_collection]
-          raise Lutaml::Model::NoRootMappingError.new(self) unless valid
+          raise Lutaml::Model::TypeOnlyMappingError.new(self) unless valid
 
           options[:encoding] = doc.encoding
           if doc.is_a?(Lutaml::Xml::Document) && doc.doctype

data/lib/lutaml/xml/serialization/instance_methods.rb

@@ -204,7 +204,7 @@ module Lutaml
           return super unless format == :xml
           return if options[:collection] || self.class.root?(lutaml_register)
 
-          raise Lutaml::Model::NoRootMappingError.new(self.class)
+          raise Lutaml::Model::TypeOnlyMappingError.new(self.class)
         end
 
         # XML-specific instance options preparation

data/lib/lutaml/xml.rb

@@ -134,7 +134,6 @@ module Lutaml
     autoload :ElementPrefixResolver, "#{__dir__}/xml/element_prefix_resolver"
     autoload :FormatChooser, "#{__dir__}/xml/format_chooser"
     autoload :HoistingAlgorithm, "#{__dir__}/xml/hoisting_algorithm"
-    autoload :HoistingAlgorithm, "#{__dir__}/xml/hoisting_algorithm"
     autoload :NamespaceInheritanceResolver,
              "#{__dir__}/xml/namespace_inheritance_resolver"
     autoload :NamespaceScopeConfig, "#{__dir__}/xml/namespace_scope_config"
@@ -229,7 +228,7 @@ end
 Lutaml::Model::Attribute.format_specific_warn_names.push(:element_order,
                                                          :schema_location, :encoding, :doctype, :ordered?, :mixed?)
 
-# Prepend XML-specific Collection overrides (no_root handling for XML)
+# Prepend XML-specific Collection overrides (unwrapped collection handling for XML)
 require_relative "xml/serialization/collection_ext"
 Lutaml::Model::Collection.singleton_class.prepend(
   Lutaml::Xml::Serialization::CollectionExt,

data/lib/tasks/memory_profile.rb

@@ -18,7 +18,7 @@ class Address < Lutaml::Model::Serializable
   attribute :country, :string
 
   xml do
-    root "address"
+    element "address"
     map_element "street", to: :street
     map_element "city", to: :city
     map_element "zip", to: :zip
@@ -37,7 +37,7 @@ class Person < Lutaml::Model::Serializable
   attribute :tags, :string, collection: true
 
   xml do
-    root "person"
+    element "person"
     map_attribute "id", to: :id
     map_element "first_name", to: :first_name
     map_element "last_name", to: :last_name

data/lib/tasks/performance_benchmark.rb

@@ -21,7 +21,7 @@ module Lutaml
           attribute :created_at, :date_time
 
           xml do
-            root "simple"
+            element "simple"
             map_attribute "id", to: :id
             map_element "name", to: :name
             map_element "active", to: :active
@@ -46,7 +46,7 @@ module Lutaml
           attribute :country, :string
 
           xml do
-            root "address"
+            element "address"
             map_element "street", to: :street
             map_element "city", to: :city
             map_element "zip", to: :zip
@@ -73,7 +73,7 @@ module Lutaml
           attribute :tags, :string, collection: true
 
           xml do
-            root "person"
+            element "person"
             map_attribute "id", to: :id
             map_element "first_name", to: :first_name
             map_element "last_name", to: :last_name
@@ -103,7 +103,7 @@ module Lutaml
           attribute :price, :float
 
           xml do
-            root "item"
+            element "item"
             map_attribute "product_id", to: :product_id
             map_element "quantity", to: :quantity
             map_element "price", to: :price
@@ -118,7 +118,7 @@ module Lutaml
           attribute :status, :string
 
           xml do
-            root "order"
+            element "order"
             map_attribute "id", to: :id
             map_element "customer", to: :customer
             map_element "item", to: :items

data/spec/lutaml/key_value/transformation/rule_compiler_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Lutaml::KeyValue::Transformation::RuleCompiler do
       attribute :active, :boolean
 
       json do
-        root "person"
+        key "person"
         map "name", to: :name
         map "age", to: :age
         map "active", to: :active

data/spec/lutaml/key_value/transformation/value_serializer_spec.rb

@@ -91,7 +91,7 @@ RSpec.describe Lutaml::KeyValue::Transformation::ValueSerializer do
         Class.new(Lutaml::Model::Serializable) do
           attribute :name, :string
           json do
-            root "nested"
+            key "nested"
             map "name", to: :name
           end
         end

data/spec/lutaml/model/attribute_collection_spec.rb

@@ -19,7 +19,7 @@ module AttributeCollection
     end
 
     key_value do
-      root "titles"
+      key "titles"
       map_instances to: :title_parts
     end
 

data/spec/lutaml/model/cli_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe Lutaml::Model::Cli do
         attribute :extract_language, ExtractLanguage, collection: true
 
         xml do
-          root "termium_extract"
+          element "termium_extract"
           namespace TermiumNamespace
 
           map_attribute "language", to: :language, namespace: nil