lutaml-model 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bc036758cf2a4ac1420e14fc6be130730410ab183cd002ced260bdbf08793eb
-  data.tar.gz: 1dfc1b473558992eb1481a535d86c1688313951530762c9317af90413028032e
+  metadata.gz: c356719b1c0c3434ba1acb3f59be81cb9374403c8020710ee4d4a5ea78748765
+  data.tar.gz: ac2aa51ef80ce8db3c50b8055df95b6a3732e3e40b72689c635e8ac22fe889f2
 SHA512:
-  metadata.gz: 8a4cec37c9acf840b89f6f363aecb8e7bf1a2237d962c6fa8bbe4d4422848cc63812efbd86369780c0e7d26470ff9f220284d062af86b9ebf7f621f3f8e579cb
-  data.tar.gz: a48c77e4d99c97fb8cc6fa6793a45b2ba12b79196d9340a23bf4d43a1090c84c05a2402a84ab52792b105713c78caa51f58cfcb141cf79459b06c929adac11b5
+  metadata.gz: b63ac862dc2eeef4a599ff5ada8c6f2434b3bf71187b5813a2637e69f25170692d373bffb2b9413b48323b1cd6161a8529a2ec6582a2fc313d46c95fa8b67088
+  data.tar.gz: 24e23bdedad47cc0796cff0bad1b32809c649bad4a13a64b23d08b3bef2dad4c769cfc299cdb85abeffd9a53ea677c41f91c759114f320a5047787cafc6c253e

data/.github/workflows/dependent-tests.yml

@@ -19,8 +19,11 @@ on:
 
 jobs:
   rake:
-    uses: metanorma/ci/.github/workflows/dependent-rake.yml@fix/add-pat-token
+    uses: metanorma/ci/.github/workflows/dependent-rake.yml@main
     with:
       command: bundle exec rspec
+      setup-tools: 'inkscape,ghostscript,exiftool,ffmpeg,imagemagick'
+      after-setup-ruby: |
+        if [ -f frontend/package.json ]; then cd frontend && npm install && npm run build; fi
     secrets:
       pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-05-06 13:11:11 UTC using RuboCop version 1.86.1.
+# on 2026-05-13 07:30:26 UTC using RuboCop version 1.86.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
@@ -11,13 +11,67 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'lutaml-model.gemspec'
 
-# Offense count: 3264
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/lutaml/xml/adapter/plan_based_builder.rb'
+    - 'lib/lutaml/xml/adapter/xml_parser.rb'
+    - 'lib/lutaml/xml/serialization/instance_methods.rb'
+    - 'spec/lutaml/xml/schema/compiler_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: IndentationWidth.
+Layout/AssignmentIndentation:
+  Exclude:
+    - 'lib/lutaml/xml/adapter/xml_serializer.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'lib/lutaml/xml/serialization/format_conversion.rb'
+    - 'lib/lutaml/xml/xml_element.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'lib/lutaml/xml/serialization/format_conversion.rb'
+    - 'lib/lutaml/xml/xml_element.rb'
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
+# SupportedStylesAlignWith: start_of_line, relative_to_receiver
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/lutaml/xml/serialization/format_conversion.rb'
+    - 'lib/lutaml/xml/xml_element.rb'
+
+# Offense count: 2981
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Enabled: false
 
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/lutaml/xml/adapter/plan_based_builder.rb'
+    - 'lib/lutaml/xml/adapter/xml_parser.rb'
+    - 'lib/lutaml/xml/adapter/xml_serializer.rb'
+    - 'lib/lutaml/xml/serialization/instance_methods.rb'
+    - 'spec/lutaml/xml/schema/compiler_spec.rb'
+
 # Offense count: 21
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
@@ -34,10 +88,16 @@ Lint/ConstantDefinitionInBlock:
 Lint/DuplicateBranch:
   Enabled: false
 
-# Offense count: 3
+# Offense count: 22
 Lint/DuplicateMethods:
   Exclude:
     - 'lib/lutaml/xml/mapping.rb'
+    - 'spec/lutaml/model/liquid_compatibility_spec.rb'
+    - 'spec/lutaml/xml/namespace_no_hoisting_spec.rb'
+    - 'spec/lutaml/xml/namespace_scope_declare_spec.rb'
+    - 'spec/lutaml/xml/namespace_scope_vcard_spec.rb'
+    - 'spec/lutaml/xml/prefix_control_spec.rb'
+    - 'spec/lutaml/xml/type_namespace_examples_spec.rb'
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
@@ -90,13 +150,12 @@ Lint/StructNewOverride:
   Exclude:
     - 'lib/lutaml/model/import_registry.rb'
 
-# Offense count: 15
+# Offense count: 14
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods, NotImplementedExceptions.
 # NotImplementedExceptions: NotImplementedError
 Lint/UnusedMethodArgument:
   Exclude:
-    - 'lib/lutaml/xml/adapter/nokogiri_adapter.rb'
     - 'lib/lutaml/xml/declaration_planner.rb'
     - 'lib/lutaml/xml/mapping.rb'
     - 'lib/lutaml/xml/namespace_collector.rb'
@@ -104,45 +163,44 @@ Lint/UnusedMethodArgument:
     - 'lib/lutaml/xml/unqualified_inheritance_strategy.rb'
     - 'spec/support/xml/xsd/code_example_validator.rb'
 
-# Offense count: 3
+# Offense count: 1
 Lint/UselessConstantScoping:
   Exclude:
-    - 'lib/lutaml/xml/adapter/nokogiri_adapter.rb'
     - 'lib/lutaml/xml/mapping_rule.rb'
 
-# Offense count: 355
+# Offense count: 342
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
 
-# Offense count: 54
+# Offense count: 39
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
   Max: 127
 
-# Offense count: 20
+# Offense count: 16
 # Configuration parameters: CountBlocks, CountModifierForms.
 Metrics/BlockNesting:
   Max: 6
 
-# Offense count: 315
+# Offense count: 300
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Offense count: 575
+# Offense count: 549
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 514
 
-# Offense count: 88
+# Offense count: 81
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 24
   MaxOptionalParameters: 5
 
-# Offense count: 264
+# Offense count: 251
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Enabled: false
@@ -234,7 +292,7 @@ RSpec/BeforeAfterAll:
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 92
+# Offense count: 94
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Enabled: false
@@ -245,7 +303,7 @@ RSpec/DescribeMethod:
     - 'spec/lutaml/xml/schema/xsd/schema_helper_methods_spec.rb'
     - 'spec/lutaml/xml/serializable_namespace_spec.rb'
 
-# Offense count: 1234
+# Offense count: 1238
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 68
@@ -320,7 +378,7 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/xml/namespace_resolution_strategy_spec.rb'
     - 'spec/lutaml/xml/xml_space_type_spec.rb'
 
-# Offense count: 1442
+# Offense count: 1468
 RSpec/MultipleExpectations:
   Max: 21
 
@@ -344,7 +402,7 @@ RSpec/NoExpectationExample:
     - 'spec/lutaml/model/global_context_spec.rb'
     - 'spec/lutaml/model/type_context_spec.rb'
 
-# Offense count: 11
+# Offense count: 10
 RSpec/RemoveConst:
   Exclude:
     - 'spec/lutaml/xml/schema/compiler_spec.rb'
@@ -393,6 +451,18 @@ Security/MarshalLoad:
   Exclude:
     - 'scripts-xmi-profile/profile_xmi.rb'
 
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'lib/lutaml/xml/serialization/format_conversion.rb'
+    - 'lib/lutaml/xml/xml_element.rb'
+
 # Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowedMethods, AllowedPatterns.
@@ -402,7 +472,7 @@ Style/ClassEqualityComparison:
     - 'lib/lutaml/model/attribute.rb'
     - 'lib/lutaml/model/validation/profile.rb'
 
-# Offense count: 13
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, AllowComments.
 # SupportedStyles: empty, nil, both
@@ -411,9 +481,6 @@ Style/EmptyElse:
     - 'lib/lutaml/key_value/data_model/element.rb'
     - 'lib/lutaml/key_value/transformation.rb'
     - 'lib/lutaml/model/mapping/mapping_rule.rb'
-    - 'lib/lutaml/xml/adapter/nokogiri_adapter.rb'
-    - 'lib/lutaml/xml/adapter/oga_adapter.rb'
-    - 'lib/lutaml/xml/adapter/ox_adapter.rb'
     - 'lib/lutaml/xml/declaration_planner.rb'
     - 'lib/lutaml/xml/model_transform.rb'
 
@@ -441,6 +508,14 @@ Style/MixinUsage:
     - 'bench/bench_unitsml.rb'
     - 'bench/bench_xmi.rb'
 
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/lutaml/xml/adapter/xml_parser.rb'
+    - 'lib/lutaml/xml/adapter/xml_serializer.rb'
+    - 'spec/lutaml/xml/schema/compiler_spec.rb'
+
 # Offense count: 12
 # Configuration parameters: AllowedClasses.
 Style/OneClassPerFile:

data/docs/_migrations/0-8-0-namespace-restructuring.adoc

@@ -873,6 +873,96 @@ xml do
 end
 ----
 
+== Custom XML Serialization Methods
+
+Custom XML methods declared via `with: { from: :foo_from_xml, to: :foo_to_xml }` continue to work in v0.8.0, but the runtime objects passed to them have changed. This section covers the API differences and the migration steps needed.
+
+=== `doc` is now a `CustomMethodWrapper`
+
+In v0.7.x the third argument of `def foo_to_xml(model, parent, doc)` was the underlying adapter document (Nokogiri-, Ox-, Oga-, REXML-backed). In v0.8.0 it is a `Lutaml::Xml::CustomMethodWrapper`, and `parent` is a `Lutaml::Xml::DataModel::XmlElement` rather than an adapter element. The wrapper exposes the same `create_element` / `add_text` / `add_attribute` / `add_element` surface, so straight-line code that uses only those methods keeps working.
+
+=== `add_element(parent, x)` raises `TypeError` for foreign element types
+
+`doc.add_element(parent, x)` accepts two shapes for `x`:
+
+* A `String`, parsed as an XML fragment via Moxml and grafted in as `DataModel::XmlElement` children. This is the path most existing custom methods rely on (e.g. passing the result of `instance.to_xml`).
+* A `Lutaml::Xml::DataModel::XmlElement`, added directly as a child.
+
+Anything else — most commonly a `Nokogiri::XML::Element` left over from a v0.7-style custom method that built fragments with `Nokogiri::XML::Builder` — now raises a `TypeError` with a message like:
+
+  add_element expects a String or XmlElement, got Nokogiri::XML::Element.
+  Call .to_xml on the element first.
+
+==== Fix
+
+Serialize the foreign element to a string before handing it to the wrapper:
+
+[source,ruby]
+----
+# v0.7-era pattern (works against Nokogiri-backed adapter doc, raises in 0.8)
+b.parent.elements.first.elements.each { |x| doc.add_element(parent, x) }
+
+# v0.8 fix — pass the string fragment, takes the Moxml path
+b.parent.elements.first.elements.each { |x| doc.add_element(parent, x.to_xml) }
+----
+
+The same applies to single-element handoffs:
+
+[source,ruby]
+----
+# v0.7-era
+elem = b.parent.elements.first
+doc.add_element(parent, elem)
+
+# v0.8 fix
+elem = b.parent.elements.first.to_xml
+doc.add_element(parent, elem)
+----
+
+=== Sibling walks: `parent.elements` → `current_context.children`
+
+Custom methods that introspect the document under construction — for example, an idempotency guard that checks whether a sibling element has already been emitted — need to be translated. The v0.7 idiom
+
+[source,ruby]
+----
+def already_emitted?(doc)
+  doc.parent.elements.detect { |x| x.name == "foo" }
+end
+----
+
+becomes
+
+[source,ruby]
+----
+def already_emitted?(doc)
+  doc.current_context.children.detect { |x| x.name == "foo" }
+end
+----
+
+If you need to support both v0.7 and v0.8 from the same codebase, use a version constant rather than `respond_to?` checks:
+
+[source,ruby]
+----
+def already_emitted?(doc)
+  siblings = if defined?(Lutaml::VERSION) && Gem::Version.new(Lutaml::VERSION) >= Gem::Version.new("0.8")
+               doc.current_context.children
+             else
+               doc.parent.elements
+             end
+  siblings.detect { |x| x.name == "foo" }
+end
+----
+
+=== Migration checklist for custom methods
+
+Audit each `with: { to: :*_to_xml }` method for the following patterns:
+
+. Does it call `Nokogiri::XML::Builder.new`, `Ox.dump`, or any other adapter-specific builder, then pass the resulting elements to `doc.add_element`? → Convert each element to a string via `.to_xml` (or equivalent) before passing.
+. Does it walk `doc.parent.elements` / `doc.parent.children`? → Translate to `doc.current_context.children`.
+. Does it cast `doc` to a specific adapter type, or call adapter-specific methods on it? → Replace with the wrapper API (`create_element`, `add_text`, `add_attribute`, `add_element`).
+
+Test by round-tripping a representative fixture through `Model.from_xml(file).to_xml` and asserting equivalence. Foreign types will now raise `TypeError` rather than being silently dropped.
+
 == Testing Your Migration
 
 After updating, run your test suite:

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.8.5"
+    VERSION = "0.8.6"
   end
 end

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

@@ -29,7 +29,7 @@ module Lutaml
           when Moxml::Cdata
             "#cdata-section"
           when Moxml::ProcessingInstruction
-            "processing_instruction"
+            element.target
           when Moxml::Comment
             "comment"
           else
@@ -102,47 +102,6 @@ module Lutaml
         def text_node?(node)
           TEXT_CLASSES.include?(node.class)
         end
-
-        # Build Element object from child node
-        #
-        # @param child [Moxml::Node] The child node
-        # @return [Element] The Element object
-        def build_element_from_child(child)
-          if text_node?(child)
-            Element.new("Text", "text", node_type: :text)
-          else
-            Element.new("Element", name_of(child), node_type: :element)
-          end
-        end
-
-        # Get the prefix for a namespace URI from hoisted declarations
-        #
-        # This checks if a namespace URI is already declared in hoisted_declarations
-        # and returns the prefix that should be used. This prevents duplicate xmlns
-        # declarations when both hoisted_declarations and attribute code try to add
-        # the same namespace.
-        #
-        # @param namespace_uri [String] The namespace URI to look up
-        # @param hoisted_declarations [Hash{String, nil => String}] The hoisted declarations
-        #   (keys are prefixes or nil for default, values are URIs)
-        # @return [String, nil] The prefix if found, nil if not hoisted
-        def prefix_for_namespace_uri(namespace_uri, hoisted_declarations)
-          return nil unless hoisted_declarations
-
-          hoisted_declarations.each do |prefix, uri|
-            return prefix if uri == namespace_uri
-          end
-          nil
-        end
-
-        # Check if a namespace URI is already hoisted
-        #
-        # @param namespace_uri [String] The namespace URI to check
-        # @param hoisted_declarations [Hash{String, nil => String}] The hoisted declarations
-        # @return [Boolean] true if the namespace is already hoisted
-        def namespace_uri_hoisted?(namespace_uri, hoisted_declarations)
-          prefix_for_namespace_uri(namespace_uri, hoisted_declarations) != nil
-        end
       end
     end
   end