lutaml-model 0.3.19 → 0.3.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa234d9dee0cbe45d559e6f4141d81ac6eecbb8c931afa77ec82f5d6d9129267
-  data.tar.gz: cee349d535ecbc950629123438ca1d3d2161288984806d49857d2dd215e4d1ec
+  metadata.gz: f32654b195dc5ec1ea1d1969a8bd72e4f67b58c6995d4a18bcbea305422cf051
+  data.tar.gz: d1ee4d99a0a98e420ba4b779bfae6e8ceab2c908c508938aa3def80e04507169
 SHA512:
-  metadata.gz: d5825d1afeb2bef26607379380722a9506795cce5635132355785ddece46086f1a16644b7d7c8960c9f103816e80bdd97d8d01e7f2d1790c3328dfbe1afdab5c
-  data.tar.gz: 14bd971607b8420c45bf3cda5badc91ddfeeb82e83918e5eb85f529fe807b7c1c25e02480412db33b91d80cebc4c6f1929e14ca946d9ef2c9ec1ed621239d508
+  metadata.gz: ea73bd1071eeddac4a64dfd10b87f09cd2a357d3c841ca7169fc17edf629e8bfb1df0faa21ec2a080537022eab8a702f667cc1d0891175bb3e6181c0653a11ac
+  data.tar.gz: 7d1f186d1a51faac0abce30525e4fdc815e9c8ac7b7f8c4387a5caaa8a4db7cfea972ad18f61d3b87a4fa1cc1613ef84de2644e1e6502c8e8890a38b7a125f72

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-10-28 08:29:46 UTC using RuboCop version 1.66.1.
+# on 2024-10-30 07:34:33 UTC using RuboCop version 1.66.1.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 148
+# Offense count: 146
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -46,7 +46,7 @@ Metrics/AbcSize:
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
     - 'lib/lutaml/model/xml_mapping_rule.rb'
 
-# Offense count: 6
+# Offense count: 5
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
@@ -64,12 +64,12 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 50
+# Offense count: 51
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 51
+  Max: 43
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 13
@@ -85,12 +85,11 @@ Metrics/PerceivedComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 9
+# Offense count: 7
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Exclude:
-    - 'spec/lutaml/model/xml_adapter/nokogiri_adapter_spec.rb'
     - 'spec/lutaml/model/xml_adapter/oga_adapter_spec.rb'
     - 'spec/lutaml/model/xml_adapter/ox_adapter_spec.rb'
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'

data/README.adoc

@@ -618,6 +618,73 @@ end
 ----
 ====
 
+
+==== Mapping all content (XML only)
+
+WARNING: This feature is only applicable to XML (for now).
+
+The `map_all` tag in XML mapping captures and maps all content within an XML
+element into a single attribute in the target Ruby object.
+
+The use case for `map_all` is to tell Lutaml::Model to not parse the content of
+the XML element at all, and instead handle it as an XML string.
+
+This is useful in the case where the content of an XML element is not to be
+handled by a Lutaml::Model::Serializable object.
+
+This feature is commonly used with custom methods or a custom model object to
+handle the content.
+
+This includes:
+
+* nested tags
+* attributes
+* text nodes
+
+The `map_all` tag is **exclusive** and cannot be combined with other mappings
+(`map_element`, `map_attribute`, `map_content`) for the same element, ensuring
+it captures the entire inner XML content.
+
+NOTE: An error is raised if `map_all` is defined alongside any other mapping in
+the same XML mapping context.
+
+Syntax:
+
+[source,ruby]
+----
+xml do
+  map_all to: :name_of_attribute
+end
+----
+
+.Mapping all the content using `map_all`
+[example]
+====
+[source,ruby]
+----
+class ExampleMapping < Lutaml::Model::Serializable
+  attribute :description, :string
+
+  xml do
+    map_all to: :description
+  end
+end
+----
+
+[source,xml]
+----
+<ExampleMapping>Content with <b>tags</b> and <i>formatting</i>.</ExampleMapping>
+----
+
+[source,ruby]
+----
+> parsed = ExampleMapping.from_xml(xml)
+> puts parsed.all_content
+# "Content with <b>tags</b> and <i>formatting</i>."
+----
+====
+
+
 ==== Mapping elements
 
 The `map_element` method maps an XML element to a data model attribute.

data/lib/lutaml/model/attribute.rb

@@ -13,9 +13,12 @@ module Lutaml
 
       def initialize(name, type, options = {})
         @name = name
-        @type = cast_type(type)
+
+        validate_type!(type)
+        @type = cast_type!(type)
+
+        validate_options!(options)
         @options = options
-        validate_options!
 
         @raw = !!options[:raw]
 
@@ -29,7 +32,7 @@ module Lutaml
         @options[:delegate]
       end
 
-      def cast_type(type)
+      def cast_type!(type)
         case type
         when Class
           type
@@ -212,11 +215,18 @@ module Lutaml
 
       private
 
-      def validate_options!
-        if (options = @options.keys - ALLOWED_OPTIONS).any?
-          raise StandardError, "Invalid options given for `#{name}` #{options}"
+      def validate_options!(options)
+        if (invalid_opts = options.keys - ALLOWED_OPTIONS).any?
+          raise StandardError, "Invalid options given for `#{name}` #{invalid_opts}"
         end
       end
+
+      def validate_type!(type)
+        return true if type.is_a?(Class)
+        return true if [Symbol, String].include?(type.class) && cast_type!(type)
+
+        raise ArgumentError, "Invalid type: #{type}, must be a Symbol, String or a Class"
+      end
     end
   end
 end

data/lib/lutaml/model/serialize.rb

@@ -332,7 +332,9 @@ module Lutaml
           mappings.each do |rule|
             raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
 
-            value = if rule.content_mapping?
+            value = if rule.raw_mapping?
+                      doc.node.inner_xml
+                    elsif rule.content_mapping?
                       doc["text"]
                     elsif doc.key_exist?(rule.namespaced_name)
                       doc.fetch(rule.namespaced_name)
@@ -397,16 +399,21 @@ module Lutaml
                     value
                   end
 
-          if attr && !rule.content_mapping? && !rule.custom_methods[:from]
-            value = attr.cast(
-              value,
-              :xml,
-              caller_class: self,
-              mixed_content: rule.mixed_content,
-            )
-          end
+          return value unless cast_value?(attr, rule)
 
-          value
+          attr.cast(
+            value,
+            :xml,
+            caller_class: self,
+            mixed_content: rule.mixed_content,
+          )
+        end
+
+        def cast_value?(attr, rule)
+          attr &&
+            !rule.raw_mapping? &&
+            !rule.content_mapping? &&
+            !rule.custom_methods[:from]
         end
 
         def text_hash?(attr, value)

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.19"
+    VERSION = "0.3.21"
   end
 end

data/lib/lutaml/model/xml_adapter/nokogiri_adapter.rb

@@ -33,6 +33,16 @@ module Lutaml
 
         private
 
+        def prefix_xml(xml, mapping, options)
+          if options.key?(:namespace_prefix)
+            options[:namespace_prefix] ? xml[options[:namespace_prefix]] : xml
+          elsif mapping.namespace_prefix
+            xml[mapping.namespace_prefix]
+          else
+            xml
+          end
+        end
+
         def build_ordered_element(xml, element, options = {})
           mapper_class = options[:mapper_class] || element.class
           xml_mapping = mapper_class.mappings_for(:xml)
@@ -40,13 +50,7 @@ module Lutaml
 
           attributes = build_attributes(element, xml_mapping)&.compact
 
-          prefixed_xml = if options.key?(:namespace_prefix)
-                           options[:namespace_prefix] ? xml[options[:namespace_prefix]] : xml
-                         elsif xml_mapping.namespace_prefix
-                           xml[xml_mapping.namespace_prefix]
-                         else
-                           xml
-                         end
+          prefixed_xml = prefix_xml(xml, xml_mapping, options)
 
           tag_name = options[:tag_name] || xml_mapping.root_element
           tag_name = "#{tag_name}_" if prefixed_xml.respond_to?(tag_name)
@@ -148,6 +152,10 @@ module Lutaml
           build_xml.doc.root.to_xml
         end
 
+        def inner_xml
+          children.map(&:to_xml).join
+        end
+
         def build_xml(builder = nil)
           builder ||= Builder::Nokogiri.build
 

data/lib/lutaml/model/xml_adapter/ox_adapter.rb

@@ -89,6 +89,8 @@ module Lutaml
         def initialize(node, root_node: nil)
           if node.is_a?(String)
             super("text", {}, [], node, parent_document: root_node)
+          elsif node.is_a?(Ox::Comment)
+            super("comment", {}, [], node.value, parent_document: root_node)
           else
             namespace_attributes(node.attributes).each do |(name, value)|
               if root_node

data/lib/lutaml/model/xml_adapter/xml_document.rb

@@ -227,16 +227,36 @@ module Lutaml
               )
             end
 
-            if (content_rule = xml_mapping.content_mapping)
-              if content_rule.custom_methods[:to]
-                @root.send(content_rule.custom_methods[:to], element,
-                           prefixed_xml.parent, prefixed_xml)
-              else
-                text = content_rule.serialize(element)
-                text = text.join if text.is_a?(Array)
-                prefixed_xml.add_text(xml, text)
-              end
-            end
+            process_content_mapping(element, xml_mapping.content_mapping, prefixed_xml)
+
+            process_raw_mapping(element, xml_mapping.raw_mapping, prefixed_xml)
+          end
+        end
+
+        def process_raw_mapping(element, rule, xml)
+          return unless rule
+
+          value = attribute_value_for(element, rule)
+          return unless render_element?(rule, element, value)
+
+          xml.add_text(xml, value)
+        end
+
+        def process_content_mapping(element, content_rule, xml)
+          return unless content_rule
+
+          if content_rule.custom_methods[:to]
+            @root.send(
+              content_rule.custom_methods[:to],
+              element,
+              xml.parent,
+              xml,
+            )
+          else
+            text = content_rule.serialize(element)
+            text = text.join if text.is_a?(Array)
+
+            xml.add_text(xml, text)
           end
         end
 

data/lib/lutaml/model/xml_mapping.rb

@@ -13,6 +13,7 @@ module Lutaml
         @elements = {}
         @attributes = {}
         @content_mapping = nil
+        @raw_mapping = nil
         @mixed_content = false
       end
 
@@ -123,7 +124,39 @@ module Lutaml
         )
       end
 
+      def map_all(
+        to:,
+        render_nil: false,
+        render_default: false,
+        delegate: nil,
+        with: {},
+        namespace: (namespace_set = false
+                    nil),
+        prefix: (prefix_set = false
+                 nil)
+      )
+        validate!("__raw_mapping", to, with)
+
+        rule = XmlMappingRule.new(
+          "__raw_mapping",
+          to: to,
+          render_nil: render_nil,
+          render_default: render_default,
+          with: with,
+          delegate: delegate,
+          namespace: namespace,
+          prefix: prefix,
+          default_namespace: namespace_uri,
+          namespace_set: namespace_set != false,
+          prefix_set: prefix_set != false,
+        )
+
+        @raw_mapping = rule
+      end
+
       def validate!(key, to, with)
+        validate_mappings!(key)
+
         if to.nil? && with.empty?
           msg = ":to or :with argument is required for mapping '#{key}'"
           raise IncorrectMappingArgumentsError.new(msg)
@@ -135,6 +168,16 @@ module Lutaml
         end
       end
 
+      def validate_mappings!(key)
+        unless @raw_mapping.nil?
+          raise StandardError, "no other mappings are allowed with map_all"
+        end
+
+        if !mappings.empty? && key == "__raw_mapping"
+          raise StandardError, "map_all is not allowed with other mappings"
+        end
+      end
+
       def elements
         @elements.values
       end
@@ -147,8 +190,12 @@ module Lutaml
         @content_mapping
       end
 
+      def raw_mapping
+        @raw_mapping
+      end
+
       def mappings
-        elements + attributes + [content_mapping].compact
+        elements + attributes + [content_mapping, raw_mapping].compact
       end
 
       def element(name)

data/lib/lutaml/model/xml_mapping_rule.rb

@@ -57,6 +57,10 @@ module Lutaml
         name.nil?
       end
 
+      def raw_mapping?
+        name == "__raw_mapping"
+      end
+
       def mixed_content?
         !!@mixed_content
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-model
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 0.3.21
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor