lutaml-model 0.8.46 → 0.8.47

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f28f3c9d10541b92778ec5ab996c7b41110bb5784b4832d08e650a758db5f8
-  data.tar.gz: 22b516d73a1b76acf9421226b3f00204c3dec0cc46e4e1a9f1531ee979b1f8a2
+  metadata.gz: c4ba22dbb3a53b5ba0cdb11840f7940507da76da3d3b7b3ccd64e52f597bdfe1
+  data.tar.gz: '09d45f38541abb51224c9af9a4aff11d3207a99c4c9f79206cc0a6041caa382e'
 SHA512:
-  metadata.gz: 779f779b5b3d76947306eec00d8652c4d8ca5e41a1a5846df1b34d5b52c03cc7e6302a53a4280d921aaddc96172daed52e1476b0662b60af40ea49558cba87f5
-  data.tar.gz: 1e19049f5e0e8a57218bdd2d6a3366f018c37b53a773c6f660d18eb071fa7736db3521762040314097b0ab8b0d9507bd2a778a06af17719935c013639854ff82
+  metadata.gz: 2a9fa0ec81775e5b928dbeb8d75b8b812d8e00c076176c1f6367e024d0bd85fd10ea27b3361160211dc47d275edff90b6d569e2ebf87b63a2f8bbba1ebf12024
+  data.tar.gz: '089b06566a9ec168c0491b7c584e95e68dc0bcb2c219b8932062aa3b33c3e5d696445e26782107c292c405cdead641ba33ad6571ac31f59403b2ac90d5f9a71d'

data/docs/_guides/advanced-mapping.adoc

@@ -566,7 +566,8 @@ end
 === Attribute-value dispatch on a shared element name
 
 When several distinct attributes share one wire element, selected by a
-sibling attribute's value, declare the discriminator with `when_attribute:`
+sibling attribute's value, declare the discriminator key with
+`when_attribute:` and map each value to its attribute:
 
 [source,ruby]
 ----
@@ -576,14 +577,30 @@ class Requirement < Lutaml::Model::Serializable
 
   xml do
     element "requirement"
-    map_element "component", to: :guidance,
-                             when_attribute: { "type" => "guidance" }
-    map_element "component", to: :purpose,
-                             when_attribute: { "type" => "purpose" }
+    map_element "component", when_attribute: "type",
+                             to: { "guidance" => :guidance,
+                                   "purpose" => :purpose }
   end
 end
 ----
 
+That one declaration expands, at DSL time, to one rule per value —
+identical to writing each rule by hand:
+
+[source,ruby]
+----
+xml do
+  element "requirement"
+  map_element "component", to: :guidance,
+                           when_attribute: { "type" => "guidance" }
+  map_element "component", to: :purpose,
+                           when_attribute: { "type" => "purpose" }
+end
+----
+
+Use the per-rule form when a partition is partial (only some values
+claimed) or a rule needs several pairs — multiple pairs mean AND.
+
 Each rule hydrates only from the `<component>` occurrences whose `type`
 attribute carries the expected value, in document order; uncovered values
 are ignored by all discriminator rules. On serialization the discriminator
@@ -607,8 +624,8 @@ everything left, so the strict policy never fires when one is present.
 ----
 xml do
   element "requirement"
-  map_element "component", to: :guidance,
-                           when_attribute: { "type" => "guidance" },
+  map_element "component", when_attribute: "type",
+                           to: { "guidance" => :guidance },
                            unmatched: :raise
 end
 ----
@@ -635,10 +652,9 @@ discriminator it satisfies.
 xml do
   element "requirement"
   ordered
-  map_element "component", to: :guidance,
-                           when_attribute: { "type" => "guidance" }
-  map_element "component", to: :purpose,
-                           when_attribute: { "type" => "purpose" }
+  map_element "component", when_attribute: "type",
+                           to: { "guidance" => :guidance,
+                                 "purpose" => :purpose }
 end
 ----
 
@@ -660,10 +676,8 @@ class KvRequirement < Lutaml::Model::Serializable
   attribute :purpose, Component, collection: true
 
   json do
-    map "component", to: :guidance,
-                     when_attribute: { "type" => "guidance" }
-    map "component", to: :purpose,
-                     when_attribute: { "type" => "purpose" }
+    map "component", when_attribute: "type",
+                     to: { "guidance" => :guidance, "purpose" => :purpose }
   end
 end
 ----

data/lib/lutaml/key_value/mapping.rb

@@ -85,6 +85,39 @@ module Lutaml
       )
         mapping_name = name_for_mapping(root_mappings, name)
         validate!(mapping_name, to, with, render_nil, render_empty)
+
+        # lutaml-model#88: grouped form — `when_attribute: "type"` plus
+        # `to: { value => attribute }` expands to one rule per value at
+        # DSL time; the compiled rules are identical to the per-rule
+        # form, so parse/serialize behavior and speed are unchanged.
+        if when_attribute.is_a?(::String) || when_attribute.is_a?(::Symbol)
+          when_attribute_group(when_attribute, to).each do |value, target|
+            map(
+              name,
+              to: target,
+              render_nil: render_nil,
+              render_default: render_default,
+              render_empty: render_empty,
+              treat_nil: treat_nil,
+              treat_empty: treat_empty,
+              treat_omitted: treat_omitted,
+              with: with,
+              delegate: delegate,
+              child_mappings: child_mappings,
+              root_mappings: root_mappings,
+              polymorphic: polymorphic,
+              polymorphic_map: polymorphic_map,
+              transform: transform,
+              value_map: value_map,
+              when_attribute: { when_attribute.to_s => value.to_s },
+              unmatched: unmatched,
+              serialize: serialize,
+            )
+          end
+          return
+        end
+        reject_ambiguous_when_attribute!(when_attribute, to)
+
         validate_when_attribute!(when_attribute) unless when_attribute.empty?
         validate_unmatched!(unmatched, when_attribute)
         if !when_attribute.empty? && (!with.empty? || delegate)

data/lib/lutaml/model/mapping/mapping.rb

@@ -136,6 +136,47 @@ module Lutaml
               "unmatched only applies to rules declared with when_attribute"
       end
 
+      # lutaml-model#88: grouped discriminator form.
+      # `when_attribute: "type"` names the discriminator key; `to:` maps
+      # each wire value to its target attribute. Validates the shape and
+      # returns the group pairs — the DSL then expands one rule per
+      # value, so the compiled rules are identical to the per-rule form.
+      def when_attribute_group(when_attribute, to)
+        if when_attribute.to_s.empty?
+          raise Lutaml::Model::IncorrectMappingArgumentsError,
+                "when_attribute group key cannot be empty"
+        end
+        unless to.is_a?(::Hash) && !to.empty?
+          raise Lutaml::Model::IncorrectMappingArgumentsError,
+                "when_attribute: #{when_attribute.inspect} is the grouped " \
+                "form and requires to: { value => attribute }, got " \
+                "to: #{to.inspect}"
+        end
+
+        to.each do |value, target|
+          next if (value.is_a?(::String) || value.is_a?(::Symbol)) &&
+            (target.is_a?(::String) || target.is_a?(::Symbol))
+
+          raise Lutaml::Model::IncorrectMappingArgumentsError,
+                "when_attribute group expects string/symbol values mapped " \
+                "to string/symbol attribute names, got " \
+                "#{value.inspect} => #{target.inspect}"
+        end
+        to
+      end
+
+      # The per-rule `{ name => value }` form maps ONE attribute; a Hash
+      # `to:` only makes sense with the grouped form.
+      def reject_ambiguous_when_attribute!(when_attribute, to)
+        return unless when_attribute.is_a?(::Hash) && !when_attribute.empty? &&
+          to.is_a?(::Hash)
+
+        raise Lutaml::Model::IncorrectMappingArgumentsError,
+              "to: must name a single attribute when when_attribute is the " \
+              "per-rule { name => value } form; the grouped form is " \
+              'when_attribute: "key", to: { value => attribute }'
+      end
+
       def register(register_id = nil)
         register_id ||= Lutaml::Model::Config.default_register
         Lutaml::Model::GlobalRegister.lookup(register_id)

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.8.46"
+    VERSION = "0.8.47"
   end
 end

data/lib/lutaml/xml/mapping.rb

@@ -539,6 +539,48 @@ module Lutaml
           name, to, with, render_nil, render_empty, type: TYPES[:element]
         )
 
+        # lutaml-model#88: grouped form — `when_attribute: "type"` plus
+        # `to: { value => attribute }` expands to one rule per value at
+        # DSL time, so the compiled rules are identical to the per-rule
+        # form and nothing downstream changes.
+        if when_attribute.is_a?(::String) || when_attribute.is_a?(::Symbol)
+          # These locals are `false` when their kwarg default ran and
+          # nil when the caller passed the kwarg explicitly (planned
+          # locals read as nil, so defined? is useless here).
+          if namespace_set.nil? || prefix_provided.nil? ||
+              xsd_type_provided.nil?
+            raise Lutaml::Model::IncorrectMappingArgumentsError,
+                  "namespace/prefix/xsd_type are not supported in the " \
+                  "grouped when_attribute form; declare rules individually"
+          end
+
+          when_attribute_group(when_attribute, to).each do |value, target|
+            map_element(
+              name,
+              to: target,
+              render_nil: render_nil,
+              render_default: render_default,
+              render_empty: render_empty,
+              treat_nil: treat_nil,
+              treat_empty: treat_empty,
+              treat_omitted: treat_omitted,
+              with: with,
+              delegate: delegate,
+              cdata: cdata,
+              polymorphic: polymorphic,
+              transform: transform,
+              value_map: value_map,
+              when_attribute: { when_attribute.to_s => value.to_s },
+              unmatched: unmatched,
+              form: form,
+              documentation: documentation,
+              raw: raw,
+            )
+          end
+          return
+        end
+        reject_ambiguous_when_attribute!(when_attribute, to)
+
         validate_when_attribute!(when_attribute) unless when_attribute.empty?
         validate_unmatched!(unmatched, when_attribute)
 

data/spec/lutaml/key_value/when_attribute_spec.rb

@@ -285,6 +285,86 @@ RSpec.describe "when_attribute for key-value formats" do
     end
   end
 
+  describe "grouped form" do
+    let(:grouped) do
+      Class.new(Lutaml::Model::Serializable) do
+        attribute :guidance, KvWhenComponent, collection: true
+        attribute :purpose, KvWhenComponent, collection: true
+
+        json do
+          map "component", when_attribute: "type",
+                           to: { guidance: :guidance, purpose: :purpose },
+                           unmatched: :raise
+        end
+
+        hsh do
+          map "component", when_attribute: "type",
+                           to: { guidance: :guidance, purpose: :purpose }
+        end
+      end
+    end
+
+    it "expands to one rule per value with identical behavior" do
+      stub_const("KvWhen::Grouped", grouped)
+      req = grouped.from_json(payload.to_json)
+
+      expect(req.guidance.map(&:text)).to eq(%w[g1 g2])
+      expect(req.purpose.map(&:text)).to eq(["p1"])
+      expect(JSON.parse(req.to_json)["component"]).to eq([
+                                                           { "type" => "guidance", "text" => "g1" },
+                                                           { "type" => "guidance", "text" => "g2" },
+                                                           { "type" => "purpose", "text" => "p1" },
+                                                         ])
+
+      rules = grouped.mappings_for(:json).mappings.select { |r| r.name == "component" }
+      expect(rules.map(&:when_attribute)).to eq(
+        [{ "type" => "guidance" }, { "type" => "purpose" }],
+      )
+    end
+
+    it "works through the hash format" do
+      stub_const("KvWhen::Grouped", grouped)
+      req = grouped.from_hash(
+        "component" => [{ type: "purpose", text: "p1" }],
+      )
+
+      expect(req.purpose.map(&:text)).to eq(["p1"])
+      expect(req.guidance).to be_empty
+    end
+
+    it "forwards the unmatched policy to every rule" do
+      stub_const("KvWhen::Grouped", grouped)
+
+      expect do
+        grouped.from_json({ "component" => [{ "type" => "nope" }] }.to_json)
+      end.to raise_error(Lutaml::Model::UnknownDiscriminatorError, /type="nope"/)
+    end
+
+    it "rejects the grouped form without a to: map" do
+      expect do
+        Class.new(Lutaml::Model::Serializable) do
+          attribute :x, :string
+
+          json do
+            map "x", to: :x, when_attribute: "type"
+          end
+        end
+      end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /to:/)
+    end
+
+    it "rejects a Hash to: with the per-rule form" do
+      expect do
+        Class.new(Lutaml::Model::Serializable) do
+          attribute :x, :string
+
+          json do
+            map "x", when_attribute: { "type" => "a" }, to: { "a" => :x }
+          end
+        end
+      end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /single attribute/)
+    end
+  end
+
   describe "DSL validation" do
     it "rejects non-string/symbol pairs" do
       expect do

data/spec/lutaml/xml/when_attribute_spec.rb

@@ -131,6 +131,99 @@ RSpec.describe "when_attribute discriminator mappings" do
     end.to raise_error(ArgumentError)
   end
 
+  describe "grouped form" do
+    let(:grouped) do
+      Class.new(Lutaml::Model::Serializable) do
+        attribute :guidance, WhenAttrComponent, collection: true
+        attribute :purpose, WhenAttrComponent, collection: true
+
+        xml do
+          element "requirement"
+          map_element "component", when_attribute: "type",
+                                   to: { "guidance" => :guidance,
+                                         "purpose" => :purpose },
+                                   unmatched: :raise
+        end
+      end
+    end
+
+    let(:grouped_xml) do
+      <<~XML
+        <requirement>
+          <component type="guidance"><text>g1</text></component>
+          <component type="purpose"><text>p1</text></component>
+          <component type="guidance"><text>g2</text></component>
+        </requirement>
+      XML
+    end
+
+    it "expands to one rule per value with identical behavior" do
+      stub_const("WhenAttr::Grouped", grouped)
+      req = grouped.from_xml(grouped_xml)
+
+      expect(req.guidance.map(&:text)).to eq(%w[g1 g2])
+      expect(req.purpose.map(&:text)).to eq(["p1"])
+      expect(req.to_xml).to include('type="guidance"')
+
+      rules = grouped.mappings_for(:xml).mappings.select { |r| r.name == "component" }
+      expect(rules.map(&:when_attribute)).to eq(
+        [{ "type" => "guidance" }, { "type" => "purpose" }],
+      )
+    end
+
+    it "forwards the unmatched policy to every rule" do
+      stub_const("WhenAttr::Grouped", grouped)
+
+      expect do
+        grouped.from_xml(
+          '<requirement><component type="other"><text>x</text></component></requirement>',
+        )
+      end.to raise_error(Lutaml::Model::UnknownDiscriminatorError, /type="other"/)
+    end
+
+    it "rejects the grouped form without a to: map" do
+      expect do
+        Class.new(Lutaml::Model::Serializable) do
+          attribute :x, :string
+
+          xml do
+            element "x"
+            map_element "x", to: :x, when_attribute: "type"
+          end
+        end
+      end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /to:/)
+    end
+
+    it "rejects a Hash to: with the per-rule form" do
+      expect do
+        Class.new(Lutaml::Model::Serializable) do
+          attribute :x, :string
+
+          xml do
+            element "x"
+            map_element "x", when_attribute: { "type" => "a" },
+                             to: { "a" => :x }
+          end
+        end
+      end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /single attribute/)
+    end
+
+    it "rejects namespace in the grouped form" do
+      expect do
+        Class.new(Lutaml::Model::Serializable) do
+          attribute :x, :string
+
+          xml do
+            element "x"
+            map_element "x", when_attribute: "type",
+                             to: { "a" => :x },
+                             namespace: "https://example.com"
+          end
+        end
+      end.to raise_error(Lutaml::Model::IncorrectMappingArgumentsError, /grouped/)
+    end
+  end
+
   # Orthogonality guard: `when_attribute` partitions occurrences across
   # attributes; `polymorphic` dispatches the class of each hydrated item.
   # Different axes over the same discriminator concept — they compose on

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-model
 version: !ruby/object:Gem::Version
-  version: 0.8.46
+  version: 0.8.47
 platform: ruby
 authors:
 - Ribose Inc.