lutaml-model 0.8.44 → 0.8.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57902ec64a7b7915f601d0525d747ec742c78a18bd7e78469c0af41aa35d2101
-  data.tar.gz: a27ee76ad1f66aaacb324c5ba79f75dca698c3f729c2e61706ed4cbe85c0b255
+  metadata.gz: 07e6ecf8e0047cd91862259a5a9db3b1cfb09122e752cdd17a4523d7169c89c5
+  data.tar.gz: 5fd97454986a0d0f4bd1f13d75af01d0a692618acd9fafcc702bfaea7a73827f
 SHA512:
-  metadata.gz: fd6d918fcd42d655682bc769f9c047860a3bba698258137f638cafd789f7b8ee0e176c89a12c84f09310245aaa227bc33d3c344c255591b14527a691acca6088
-  data.tar.gz: 36bf72d194bc8ed3e5ddb8837c55f5dd3170006ecf37cfc26004f46133fc6684e267d56123577e06b9ca9fe2d3dfcab838a21b6bd3b884409613ea364276329e
+  metadata.gz: d95d9d885d0fbc63200900751b75c62282b63970f3fe4ebb1707ff134452bd57d714b8aad22f2253b70ea9509d1456dfd6bbee2a43f3cb292de8ae87959ab617
+  data.tar.gz: 455d7af1865469474d7f11f623dede9fbd65311dabaa30c0546a0193bdfbab4e99356b50ca6e8ffa2deb5f108ca0d5e2de9bf112e03ce607328c9ff4e6de0a8d

data/docs/_guides/advanced-mapping.adoc

@@ -596,6 +596,23 @@ as `collection: true` when the element repeats. A rule without
 `when_attribute` that shares the name only claims occurrences no
 discriminator rule claimed, so every occurrence is captured exactly once.
 
+By default an occurrence no rule claims — an uncovered discriminator
+value, or a missing discriminator attribute — is silently dropped.
+Declare `unmatched: :raise` on a discriminator rule to fail the parse
+instead: `Lutaml::Model::UnknownDiscriminatorError` names the element and
+the unclaimed discriminator values. A plain rule sharing the name claims
+everything left, so the strict policy never fires when one is present.
+
+[source,ruby]
+----
+xml do
+  element "requirement"
+  map_element "component", to: :guidance,
+                           when_attribute: { "type" => "guidance" },
+                           unmatched: :raise
+end
+----
+
 `when_attribute` and `polymorphic:` are two different dispatch axes over
 the same discriminator idea — pick by what the discriminator selects:
 

data/lib/compat/opal/lutaml_model_boot.rb

@@ -283,6 +283,7 @@ require "lutaml/model/error/type_only_namespace_error"
 require "lutaml/model/error/undefined_attribute_error"
 require "lutaml/model/error/union_schema_unsupported_error"
 require "lutaml/model/error/unknown_adapter_type_error"
+require "lutaml/model/error/unknown_discriminator_error"
 require "lutaml/model/error/unknown_sequence_mapping_error"
 require "lutaml/model/error/unknown_type_error"
 require "lutaml/model/error/unresolvable_type_error"

data/lib/lutaml/model/error/unknown_discriminator_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Lutaml
+  module Model
+    # Raised when a `when_attribute` rule declared `unmatched: :raise`
+    # parses an occurrence that no rule claims: it matches no
+    # discriminator and no plain rule shares the wire name.
+    class UnknownDiscriminatorError < Error
+    end
+  end
+end

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.8.44"
+    VERSION = "0.8.45"
   end
 end

data/lib/lutaml/model.rb

@@ -138,6 +138,8 @@ module Lutaml
     autoload :ElementCountOutOfRangeError,
              "#{__dir__}/model/error/element_count_out_of_range_error"
     autoload :ValidationError, "#{__dir__}/model/error/validation_error"
+    autoload :UnknownDiscriminatorError,
+             "#{__dir__}/model/error/unknown_discriminator_error"
     autoload :TypeNotEnabledError,
              "#{__dir__}/model/error/type_not_enabled_error"
     autoload :TypeError, "#{__dir__}/model/error/type_error"

data/lib/lutaml/xml/mapping.rb

@@ -528,6 +528,7 @@ module Lutaml
       transform: {},
       value_map: {},
       when_attribute: {},
+      unmatched: :drop,
       form: nil,
       documentation: nil,
       xsd_type: (xsd_type_provided = false
@@ -539,6 +540,7 @@ module Lutaml
         )
 
         validate_when_attribute!(when_attribute) unless when_attribute.empty?
+        validate_unmatched!(unmatched, when_attribute)
 
         # Warn if prefix parameter is provided
         if prefix_provided != false
@@ -588,6 +590,7 @@ module Lutaml
           documentation: documentation,
           raw: raw,
           when_attribute: when_attribute,
+          unmatched: unmatched,
         )
         # Store rules with the same element name in an array to support
         # multiple mapping rules for the same element name with different target types
@@ -625,6 +628,21 @@ module Lutaml
         end
       end
 
+      # lutaml-model#88: what a parse does with an occurrence that no
+      # rule on the wire name claims — :drop it (default) or :raise
+      # UnknownDiscriminatorError. Only meaningful on discriminator rules.
+      def validate_unmatched!(unmatched, when_attribute)
+        unless %i[drop raise].include?(unmatched)
+          raise Lutaml::Model::IncorrectMappingArgumentsError,
+                "unmatched expects :drop or :raise, got #{unmatched.inspect}"
+        end
+
+        return unless when_attribute.empty? && unmatched != :drop
+
+        raise Lutaml::Model::IncorrectMappingArgumentsError,
+              "unmatched only applies to rules declared with when_attribute"
+      end
+
       def map_attribute(
         name,
       to: nil,

data/lib/lutaml/xml/mapping_rule.rb

@@ -11,7 +11,8 @@ module Lutaml
                   :delimiter,
                   :form,
                   :documentation,
-                  :raw
+                  :raw,
+                  :unmatched
 
       # Writers for deep_dup (preserves exact object references)
       attr_accessor :namespace, :prefix, :namespace_class
@@ -38,6 +39,7 @@ module Lutaml
       transform: {},
       value_map: {},
       when_attribute: {},
+      unmatched: :drop,
       as_list: nil,
       delimiter: nil,
       form: nil,
@@ -66,6 +68,9 @@ module Lutaml
         # Store original namespace parameter to preserve :inherit symbol
         @namespace_param = namespace
 
+        # lutaml-model#88: policy for occurrences claimed by no rule
+        @unmatched = unmatched
+
         # Normalize namespace to XmlNamespace class
         @namespace_class = normalize_namespace(namespace)
         @namespace = @namespace_class == :blank ? nil : @namespace_class&.uri
@@ -273,6 +278,7 @@ module Lutaml
           documentation: @documentation,
           raw: @raw,
           when_attribute: when_attribute,
+          unmatched: @unmatched,
         ).tap do |dup_rule|
           # Manually preserve the exact @namespace_class object to avoid
           # recreating anonymous classes (which would have different object_ids)

data/lib/lutaml/xml/model_transform.rb

@@ -859,6 +859,35 @@ _effective_register)
         cache[type_class] = type_class.mappings_for(:xml)&.namespace_class
       end
 
+      # lutaml-model#88: fail closed for `unmatched: :raise`. An
+      # occurrence no rule on the wire name claims — no discriminator
+      # match, no plain sibling — is exactly the data the default policy
+      # silently drops.
+      def check_unmatched_discriminators!(children, rule, rule_names, session)
+        plain_names = session.plain_element_rule_names
+        return if rule_names.any? { |name| plain_names[name] }
+
+        group = rule_names.filter_map do |name|
+          session.when_attribute_siblings_by_name[name]
+        end.flatten
+        tested = group.flat_map { |sibling| sibling.when_attribute.keys }
+          .uniq.map(&:to_s)
+        children.each do |child|
+          next if group.any? { |sibling| sibling.matches_when_attribute?(child) }
+
+          values = tested.filter_map do |name|
+            value = child.find_attribute_value(name)
+            "#{name}=#{value.inspect}" if value
+          end
+          raise ::Lutaml::Model::UnknownDiscriminatorError,
+                "Element <#{rule.name}> (#{values.join(', ')}) is claimed by " \
+                "no rule: it matches no when_attribute discriminator and no " \
+                "plain rule shares the name. Cover the value, add a plain " \
+                "rule, or opt out with unmatched: :drop"
+        end
+        nil
+      end
+
       def value_for_rule(session, rule, options, cached_attr = nil,
                          extra_rule_names = nil)
         doc = session.doc
@@ -1058,6 +1087,9 @@ _effective_register)
         # no discriminator claimed — so each occurrence is captured
         # exactly once, mirroring ordered-serialization routing.
         if rule.when_attribute?
+          if rule.unmatched == :raise
+            check_unmatched_discriminators!(children, rule, rule_names, session)
+          end
           children = children.select do |child|
             rule.matches_when_attribute?(child)
           end

data/lib/lutaml/xml/parse_session.rb

@@ -66,27 +66,49 @@ module Lutaml
       end
 
       # lutaml-model#88: element wire names partitioned by `when_attribute`
-      # rules, as name -> discriminator rules. A plain rule on a
-      # partitioned name captures only occurrences no discriminator
-      # claimed — the mirror of ordered-serialization routing, so each
-      # occurrence is captured exactly once instead of double-captured by
-      # the plain rule and its discriminator sibling. Empty unless the
-      # mapping uses when_attribute at all; non-Serialize custom models
-      # have no mappings to partition.
-      def when_attribute_siblings_by_name
-        @when_attribute_siblings_by_name ||=
+      # rules. One pass builds two views over the mapping's element rules:
+      #
+      # - name -> discriminator rules. A plain rule on a partitioned name
+      #   captures only occurrences no discriminator claimed — the mirror
+      #   of ordered-serialization routing, so each occurrence is captured
+      #   exactly once instead of double-captured by the plain rule and
+      #   its discriminator sibling.
+      # - name -> true when a plain element rule also holds the name.
+      #   Everything on the name is then claimed, so `unmatched: :raise`
+      #   never fires.
+      #
+      # Empty unless the mapping uses when_attribute at all; non-Serialize
+      # custom models have no mappings to partition.
+      def when_attribute_partition
+        @when_attribute_partition ||=
           if instance_is_serialize && (mapping = xml_mapping)
-            mapping.mappings.each_with_object({}) do |rule, index|
-              pairs = rule.when_attribute
-              next if pairs.nil? || pairs.empty?
+            siblings = {}
+            plain_names = {}
+            mapping.mappings.each do |rule|
+              next if rule.attribute? || rule.content_mapping? ||
+                rule.raw_mapping? || rule.cdata
 
-              (index[rule.name.to_s] ||= []) << rule
+              pairs = rule.when_attribute
+              if pairs && !pairs.empty?
+                (siblings[rule.name.to_s] ||= []) << rule
+              else
+                plain_names[rule.name.to_s] = true
+              end
             end
+            [siblings, plain_names]
           else
-            {}
+            [{}, {}]
           end
       end
 
+      def when_attribute_siblings_by_name
+        when_attribute_partition[0]
+      end
+
+      def plain_element_rule_names
+        when_attribute_partition[1]
+      end
+
       def model_class
         @model_class ||= instance.class
       end

data/spec/lutaml/xml/when_attribute_unmatched_spec.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+# lutaml-model#88: `unmatched: :raise` on a when_attribute rule fails the
+# parse when an occurrence is claimed by no rule — no discriminator match
+# and no plain sibling on the wire name. The default (:drop) keeps the
+# silent-drop behavior.
+class UnmatchedComponent < Lutaml::Model::Serializable
+  attribute :text, :string
+
+  xml do
+    element "component"
+    map_element "text", to: :text
+  end
+end
+
+class UnmatchedRequirement < Lutaml::Model::Serializable
+  attribute :guidance, UnmatchedComponent, collection: true
+  attribute :purpose, UnmatchedComponent, collection: true
+
+  xml do
+    element "requirement"
+    map_element "component", to: :guidance,
+                             when_attribute: { "type" => "guidance" },
+                             unmatched: :raise
+    map_element "component", to: :purpose,
+                             when_attribute: { "type" => "purpose" }
+  end
+end
+
+RSpec.describe "when_attribute unmatched policy" do
+  before do
+    stub_const("Unmatched::Component", UnmatchedComponent)
+    stub_const("Unmatched::Requirement", UnmatchedRequirement)
+  end
+
+  it "parses when every occurrence is covered" do
+    req = UnmatchedRequirement.from_xml(<<~XML)
+      <requirement>
+        <component type="guidance"><text>g1</text></component>
+        <component type="purpose"><text>p1</text></component>
+      </requirement>
+    XML
+
+    expect(req.guidance.map(&:text)).to eq(["g1"])
+    expect(req.purpose.map(&:text)).to eq(["p1"])
+  end
+
+  it "raises on an unknown discriminator value" do
+    xml = <<~XML
+      <requirement>
+        <component type="guidance"><text>g1</text></component>
+        <component type="unknown"><text>x</text></component>
+      </requirement>
+    XML
+
+    expect { UnmatchedRequirement.from_xml(xml) }
+      .to raise_error(Lutaml::Model::UnknownDiscriminatorError, /type="unknown"/)
+  end
+
+  it "raises when the discriminator attribute is missing entirely" do
+    xml = "<requirement><component><text>x</text></component></requirement>"
+
+    expect { UnmatchedRequirement.from_xml(xml) }
+      .to raise_error(Lutaml::Model::UnknownDiscriminatorError, /<component>/)
+  end
+
+  it "names the tested attributes of the unclaimed occurrence" do
+    xml = '<requirement><component type="later"><text>x</text></component></requirement>'
+
+    expect { UnmatchedRequirement.from_xml(xml) }
+      .to raise_error(Lutaml::Model::UnknownDiscriminatorError, /unmatched: :drop/)
+  end
+
+  it "does not raise when a plain rule claims the leftovers" do
+    both = Class.new(Lutaml::Model::Serializable) do
+      attribute :special, UnmatchedComponent, collection: true
+      attribute :plain, UnmatchedComponent, collection: true
+
+      xml do
+        element "holder"
+        map_element "item", to: :special,
+                            when_attribute: { "kind" => "special" },
+                            unmatched: :raise
+        map_element "item", to: :plain
+      end
+    end
+    stub_const("Unmatched::Holder", both)
+
+    doc = both.from_xml(
+      '<holder><item kind="special"><text>b</text></item><item><text>a</text></item></holder>',
+    )
+
+    expect(doc.special.map(&:text)).to eq(["b"])
+    expect(doc.plain.map(&:text)).to eq(["a"])
+  end
+
+  it "drops unmatched occurrences by default" do
+    lenient = Class.new(Lutaml::Model::Serializable) do
+      attribute :guidance, UnmatchedComponent, collection: true
+
+      xml do
+        element "requirement"
+        map_element "component", to: :guidance,
+                                 when_attribute: { "type" => "guidance" }
+      end
+    end
+    stub_const("Unmatched::Lenient", lenient)
+
+    doc = lenient.from_xml(
+      '<requirement><component type="guidance"><text>g</text></component>' \
+      '<component type="other"><text>x</text></component></requirement>',
+    )
+    expect(doc.guidance.map(&:text)).to eq(["g"])
+  end
+
+  it "survives deep_dup of mappings" do
+    rule = UnmatchedRequirement.mappings_for(:xml).mappings.find do |r|
+      r.to == :guidance
+    end
+
+    expect(rule.unmatched).to eq(:raise)
+    duped = rule.deep_dup
+    expect(duped.unmatched).to eq(:raise)
+    expect(duped.when_attribute).to eq("type" => "guidance")
+  end
+
+  it "rejects unknown policy values" do
+    expect do
+      Class.new(Lutaml::Model::Serializable) do
+        attribute :x, :string
+
+        xml do
+          element "x"
+          map_element "x", to: :x,
+                           when_attribute: { "type" => "a" },
+                           unmatched: :explode
+        end
+      end
+    end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /unmatched/)
+  end
+
+  it "rejects unmatched without when_attribute" do
+    expect do
+      Class.new(Lutaml::Model::Serializable) do
+        attribute :x, :string
+
+        xml do
+          element "x"
+          map_element "x", to: :x, unmatched: :raise
+        end
+      end
+    end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /when_attribute/)
+  end
+
+  it "is rejected on attribute mappings" do
+    expect do
+      Class.new(Lutaml::Model::Serializable) do
+        attribute :x, :string
+
+        xml do
+          element "x"
+          map_attribute "x", to: :x, unmatched: :raise
+        end
+      end
+    end.to raise_error(ArgumentError)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-model
 version: !ruby/object:Gem::Version
-  version: 0.8.44
+  version: 0.8.45
 platform: ruby
 authors:
 - Ribose Inc.
@@ -489,6 +489,7 @@ files:
 - lib/lutaml/model/error/undefined_attribute_error.rb
 - lib/lutaml/model/error/union_schema_unsupported_error.rb
 - lib/lutaml/model/error/unknown_adapter_type_error.rb
+- lib/lutaml/model/error/unknown_discriminator_error.rb
 - lib/lutaml/model/error/unknown_sequence_mapping_error.rb
 - lib/lutaml/model/error/unknown_type_error.rb
 - lib/lutaml/model/error/unresolvable_type_error.rb
@@ -2008,6 +2009,7 @@ files:
 - spec/lutaml/xml/w3c_types_spec.rb
 - spec/lutaml/xml/when_attribute_ordered_spec.rb
 - spec/lutaml/xml/when_attribute_spec.rb
+- spec/lutaml/xml/when_attribute_unmatched_spec.rb
 - spec/lutaml/xml/xml_adapter_spec.rb
 - spec/lutaml/xml/xml_declaration_spec.rb
 - spec/lutaml/xml/xml_element_guard_spec.rb