lutaml-model 0.3.11 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91ff48fd66cf1435e5e18508b24cc24f7cc92dc8b5d1619c7796932eb21dcea2
-  data.tar.gz: 51eabdb2aede716ce86cea46325cad0b7b9f0da98df3235fc3b8596fe9f96bd9
+  metadata.gz: c7a3ca13f464d886f1f30bb695cc5b98151c86771214665e77734b308e4ae6e0
+  data.tar.gz: '08cf720cab0dadca493262a8fec1dbd14ffb6db53ea9f047fe978249f4c299a5'
 SHA512:
-  metadata.gz: 3ce25727c43d1c25f97e49c529c9ded5f51d8f2c13ae2766dba8c94d2c1d9a7c646bad564bfb9cd4c5555ee71395f6ff39023268e9e92044f10985c20dd826ca
-  data.tar.gz: edf1d699e944a2427b947e1a262258e93623c44bc765a5f5497c13bd4d806984722ececd6318254c15196d435b2b809f44389a1be1d9cd5f33e005169b232eaf
+  metadata.gz: bbc204ba771660eecbc9eca1b14d37470f6175fb8bb00910bc478f0928a7d03fb95f0b364339d129c1b7d9116c46be8c96344e2c944ca0061bc74ee028069c15
+  data.tar.gz: b36bd0b23f8b16ac5921ea63d187cb9c95ea1c819fc92f7007133c40580ad3a88dd4e3a50d9fa541dad9f21895fb9f5330ab45c74d8727c9b7604d3941e29b90

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-09-23 15:00:23 UTC using RuboCop version 1.65.1.
+# on 2024-10-08 13:33:09 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: 100
+# Offense count: 108
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -30,7 +30,7 @@ Lint/DuplicateMethods:
   Exclude:
     - 'lib/lutaml/model/attribute.rb'
 
-# Offense count: 34
+# Offense count: 35
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
@@ -49,9 +49,9 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 42
+  Max: 47
 
-# Offense count: 26
+# Offense count: 27
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
@@ -63,7 +63,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 45
+# Offense count: 46
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 51
@@ -71,7 +71,7 @@ Metrics/MethodLength:
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 10
+  Max: 11
 
 # Offense count: 22
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
@@ -123,7 +123,7 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 98
+# Offense count: 99
 RSpec/MultipleExpectations:
   Max: 14
 

data/README.adoc

@@ -423,6 +423,51 @@ end
 ----
 ====
 
+=== Attribute as raw string
+
+An attribute can be set to read the value as raw string for XML, by using the `raw: true` option.
+
+Syntax:
+
+[source,ruby]
+----
+attribute :name_of_attribute, :string, raw: true
+----
+
+.Using the `raw` option to read raw value for an XML attribute
+[example]
+====
+[source,ruby]
+----
+class Person < Lutaml::Model::Serializable
+  attribute :name, :string
+  attribute :description, :string, raw: true
+end
+----
+
+For the following xml
+[source,xml]
+----
+<Person>
+  <name>John Doe</name>
+  <description>
+    A <b>fictional person</b> commonly used as a <i>placeholder name</i>.
+  </description>
+</Person>
+----
+
+[source,ruby]
+----
+> Person.from_xml(xml)
+> # <Person:0x0000000107a3ca70
+    @description="\n    A <b>fictional person</b> commonly used as a <i>placeholder name</i>.\n  ",
+    @element_order=["text", "name", "text", "description", "text"],
+    @name="John Doe",
+    @ordered=nil,
+    @validate_on_set=false>
+----
+====
+
 == Serialization model mappings
 
 === General

data/lib/lutaml/model/attribute.rb

@@ -7,6 +7,7 @@ module Lutaml
         @name = name
         @type = cast_type(type)
         @options = options
+        @raw = !!options[:raw]
 
         if collection?
           validate_collection_range
@@ -14,6 +15,10 @@ module Lutaml
         end
       end
 
+      def delegate
+        @options[:delegate]
+      end
+
       def cast_type(type)
         case type
         when Class
@@ -45,8 +50,14 @@ module Lutaml
         !collection?
       end
 
+      def raw?
+        @raw
+      end
+
       def default
-        value = if options[:default].is_a?(Proc)
+        value = if delegate
+                  type.attributes[to].default
+                elsif options[:default].is_a?(Proc)
                   options[:default].call
                 else
                   options[:default]

data/lib/lutaml/model/mapping_rule.rb

@@ -7,7 +7,8 @@ module Lutaml
                   :custom_methods,
                   :delegate,
                   :mixed_content,
-                  :child_mappings
+                  :child_mappings,
+                  :default_namespace
 
       def initialize(
         name,
@@ -18,6 +19,7 @@ module Lutaml
         mixed_content: false,
         namespace_set: false,
         prefix_set: false,
+        default_namespace: nil,
         child_mappings: nil
       )
         @name = name
@@ -29,6 +31,7 @@ module Lutaml
         @namespace_set = namespace_set
         @prefix_set = prefix_set
         @child_mappings = child_mappings
+        @default_namespace = default_namespace
       end
 
       alias from name
@@ -42,19 +45,35 @@ module Lutaml
         end
       end
 
+      def namespaced_name
+        if name == "lang"
+          "#{prefix}:#{name}"
+        elsif namespace || default_namespace
+          "#{namespace || default_namespace}:#{name}"
+        else
+          name
+        end
+      end
+
       def serialize_attribute(model, element, doc)
         if custom_methods[:to]
           model.send(custom_methods[:to], model, element, doc)
         end
       end
 
+      def to_value_for(model)
+        if delegate
+          model.public_send(delegate).public_send(to)
+        else
+          model.public_send(to)
+        end
+      end
+
       def serialize(model, parent = nil, doc = nil)
         if custom_methods[:to]
           model.send(custom_methods[:to], model, parent, doc)
-        elsif delegate
-          model.public_send(delegate).public_send(to)
         else
-          model.public_send(to)
+          to_value_for(model)
         end
       end
 

data/lib/lutaml/model/serialize.rb

@@ -55,6 +55,14 @@ module Lutaml
             !!@ordered
           end
 
+          Utils.add_method_if_not_defined(klass, :mixed=) do |mixed|
+            @mixed = mixed
+          end
+
+          Utils.add_method_if_not_defined(klass, :mixed?) do
+            !!@mixed
+          end
+
           Utils.add_method_if_not_defined(klass, :element_order=) do |order|
             @element_order = order
           end
@@ -85,7 +93,7 @@ module Lutaml
         Lutaml::Model::Config::AVAILABLE_FORMATS.each do |format|
           define_method(format) do |&block|
             klass = format == :xml ? XmlMapping : KeyValueMapping
-            mappings[format] = klass.new
+            mappings[format] ||= klass.new
             mappings[format].instance_eval(&block)
 
             if format == :xml && !mappings[format].root_element
@@ -107,7 +115,12 @@ module Lutaml
                      end
             end
 
-            apply_mappings(doc.to_h, format)
+            if format == :xml
+              doc_hash = doc.parse_element(doc.root, self, :xml)
+              apply_mappings(doc_hash, format)
+            else
+              apply_mappings(doc.to_h, format)
+            end
           end
 
           define_method(:"to_#{format}") do |instance|
@@ -280,6 +293,12 @@ module Lutaml
           attributes[rule.delegate].type.attributes[rule.to]
         end
 
+        def attribute_for_child(child_name, format)
+          mapping_rule = mappings_for(format).find_by_name(child_name)
+
+          attribute_for_rule(mapping_rule) if mapping_rule
+        end
+
         def apply_mappings(doc, format, options = {})
           instance = options[:instance] || model.new
           return instance if Utils.blank?(doc)
@@ -326,7 +345,8 @@ module Lutaml
 
           if instance.respond_to?(:ordered=) && doc.is_a?(Lutaml::Model::MappingHash)
             instance.element_order = doc.item_order
-            instance.ordered = mappings_for(:xml).mixed_content? || options[:mixed_content]
+            instance.ordered = mappings_for(:xml).ordered? || options[:ordered]
+            instance.mixed = mappings_for(:xml).mixed_content? || options[:mixed_content]
           end
 
           if doc["__schema_location"]
@@ -342,8 +362,10 @@ module Lutaml
 
             value = if rule.content_mapping?
                       doc["text"]
+                    elsif doc.key?(rule.namespaced_name.to_s) || doc.key?(rule.namespaced_name.to_sym)
+                      doc[rule.namespaced_name.to_s] || doc[rule.namespaced_name.to_sym]
                     else
-                      doc[rule.name.to_s] || doc[rule.name.to_sym]
+                      rule.to_value_for(instance)
                     end
 
             value = normalize_xml_value(value, rule)
@@ -407,6 +429,7 @@ module Lutaml
       end
 
       attr_accessor :element_order, :schema_location
+      attr_writer :ordered, :mixed
 
       def initialize(attrs = {})
         @validate_on_set = attrs.delete(:validate_on_set) || false
@@ -456,11 +479,11 @@ module Lutaml
       end
 
       def ordered?
-        @ordered
+        !!@ordered
       end
 
-      def ordered=(ordered)
-        @ordered = ordered
+      def mixed?
+        !!@mixed
       end
 
       def key_exist?(hash, key)

data/lib/lutaml/model/type.rb

@@ -116,6 +116,8 @@ module Lutaml
       def self.normalize_hash(hash)
         return hash["text"] if hash.keys == ["text"]
 
+        hash = hash.to_h if hash.is_a?(Lutaml::Model::MappingHash)
+
         hash.filter_map do |key, value|
           next if key == "text"
 

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.11"
+    VERSION = "0.3.13"
   end
 end

data/lib/lutaml/model/xml_adapter/builder/nokogiri.rb

@@ -63,11 +63,9 @@ module Lutaml
             self
           end
 
-          def method_missing(method_name, *args)
+          def method_missing(method_name, *args, &block)
             if block_given?
-              xml.public_send(method_name, *args) do
-                yield(xml)
-              end
+              xml.public_send(method_name, *args, &block)
             else
               xml.public_send(method_name, *args)
             end

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

@@ -55,6 +55,7 @@ module Lutaml
             end
 
             index_hash = {}
+            content = []
 
             element.element_order.each do |name|
               index_hash[name] ||= -1
@@ -71,7 +72,11 @@ module Lutaml
                 text = xml_mapping.content_mapping.serialize(element)
                 text = text[curr_index] if text.is_a?(Array)
 
-                prefixed_xml.text text
+                if element.mixed?
+                  prefixed_xml.text text
+                else
+                  content << text
+                end
               elsif !value.nil? || element_rule.render_nil?
                 value = value[curr_index] if attribute_def.collection?
 
@@ -87,12 +92,14 @@ module Lutaml
                 )
               end
             end
+
+            prefixed_xml.text content.join
           end
         end
       end
 
       class NokogiriElement < XmlElement
-        def initialize(node, root_node: nil)
+        def initialize(node, root_node: nil, default_namespace: nil)
           if root_node
             node.namespaces.each do |prefix, name|
               namespace = XmlNamespace.new(name, prefix)
@@ -116,14 +123,15 @@ module Lutaml
               namespace_prefix: attr.namespace&.prefix,
             )
           end
-
+          default_namespace = node.namespace&.href if root_node.nil?
           super(
             node.name,
             attributes,
-            parse_all_children(node, root_node: root_node || self),
+            parse_all_children(node, root_node: root_node || self, default_namespace: default_namespace),
             node.text,
             parent_document: root_node,
             namespace_prefix: node.namespace&.prefix,
+            default_namespace: default_namespace
           )
         end
 
@@ -138,8 +146,10 @@ module Lutaml
           if name == "text"
             builder.text(text)
           else
-            builder.send(name, build_attributes(self)) do |xml|
-              children.each { |child| child.to_xml(xml) }
+            builder.public_send(name, build_attributes(self)) do |xml|
+              children.each do |child|
+                child.to_xml(xml)
+              end
             end
           end
 
@@ -154,9 +164,9 @@ module Lutaml
           end
         end
 
-        def parse_all_children(node, root_node: nil)
+        def parse_all_children(node, root_node: nil, default_namespace: nil)
           node.children.map do |child|
-            NokogiriElement.new(child, root_node: root_node)
+            NokogiriElement.new(child, root_node: root_node, default_namespace: default_namespace)
           end
         end
 

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

@@ -42,6 +42,7 @@ module Lutaml
           builder.create_and_add_element(tag_name,
                                          attributes: attributes) do |el|
             index_hash = {}
+            content = []
 
             element.element_order.each do |name|
               index_hash[name] ||= -1
@@ -58,7 +59,11 @@ module Lutaml
                 text = element.send(xml_mapping.content_mapping.to)
                 text = text[curr_index] if text.is_a?(Array)
 
-                el.add_text(el, text)
+                if element.mixed?
+                  el.add_text(el, text)
+                else
+                  content << text
+                end
               elsif !value.nil? || element_rule.render_nil?
                 value = value[curr_index] if attribute_def.collection?
 
@@ -74,6 +79,8 @@ module Lutaml
                 )
               end
             end
+
+            el.add_text(el, content.join)
           end
         end
       end

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

@@ -66,24 +66,43 @@ module Lutaml
           options[:tag_name] = rule.name
 
           options[:mapper_class] = attribute&.type if attribute
+          options[:namespace_set] = set_namespace?(rule)
 
           options
         end
 
-        def parse_element(element)
+        def parse_element(element, klass = nil, format = nil)
           result = Lutaml::Model::MappingHash.new
           result.item_order = element.order
 
           element.children.each_with_object(result) do |child, hash|
-            value = child.text? ? child.text : parse_element(child)
-
-            hash[child.unprefixed_name] = if hash[child.unprefixed_name]
-                                            [hash[child.unprefixed_name], value].flatten
+            attr = klass.attribute_for_child(child.name, format) if klass&.<= Serialize
+
+            value = if child.text?
+                      child.text
+                    elsif attr&.raw?
+                      child.children.map do |c|
+                        next c.text if c.text?
+
+                        c.to_xml.doc.root.to_xml({})
+                      end.join
+                    else
+                      parse_element(child, attr&.type || klass, format)
+                    end
+
+            hash[child.namespaced_name] = if hash[child.namespaced_name]
+                                            [hash[child.namespaced_name], value].flatten
                                           else
                                             value
                                           end
           end
 
+          result.merge(attributes_hash(element))
+        end
+
+        def attributes_hash(element)
+          result = Lutaml::Model::MappingHash.new
+
           element.attributes.each_value do |attr|
             if attr.unprefixed_name == "schemaLocation"
               result["__schema_location"] = {
@@ -92,7 +111,7 @@ module Lutaml
                 schema_location: attr.value,
               }
             else
-              result[attr.unprefixed_name] = attr.value
+              result[attr.name] = attr.value
             end
           end
 
@@ -231,13 +250,17 @@ module Lutaml
           mapper_class ? mapper_class.mappings_for(:xml).mixed_content? : false
         end
 
-        def build_namespace_attributes(klass, processed = {})
+        def set_namespace?(rule)
+          rule.nil? || !rule.namespace_set? || !rule.namespace.nil?
+        end
+
+        def build_namespace_attributes(klass, processed = {}, options = {})
           xml_mappings = klass.mappings_for(:xml)
           attributes = klass.attributes
 
           attrs = {}
 
-          if xml_mappings.namespace_uri
+          if xml_mappings.namespace_uri && set_namespace?(options[:caller_rule])
             prefixed_name = [
               "xmlns",
               xml_mappings.namespace_prefix,
@@ -262,10 +285,10 @@ module Lutaml
             next unless type
 
             if type <= Lutaml::Model::Serialize
-              attrs = attrs.merge(build_namespace_attributes(type, processed))
+              attrs = attrs.merge(build_namespace_attributes(type, processed, { caller_rule: mapping_rule }))
             end
 
-            if mapping_rule.namespace
+            if mapping_rule.namespace && mapping_rule.prefix && mapping_rule.name != "lang"
               attrs["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end
           end
@@ -274,23 +297,31 @@ module Lutaml
         end
 
         def build_attributes(element, xml_mapping, options = {})
-          attrs = namespace_attributes(xml_mapping)
+          attrs = if options.fetch(:namespace_set, true)
+                    namespace_attributes(xml_mapping)
+                  else
+                    {}
+                  end
+
+          if element.respond_to?(:schema_location) && element.schema_location
+            attrs.merge!(element.schema_location.to_xml_attributes)
+          end
 
           xml_mapping.attributes.each_with_object(attrs) do |mapping_rule, hash|
             next if options[:except]&.include?(mapping_rule.to)
             next if mapping_rule.custom_methods[:to]
 
-            if mapping_rule.namespace
+            if mapping_rule.namespace && mapping_rule.prefix && mapping_rule.name != "lang"
               hash["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end
 
-            hash[mapping_rule.prefixed_name] = element.send(mapping_rule.to)
+            hash[mapping_rule.prefixed_name] = mapping_rule.to_value_for(element)
           end
 
           xml_mapping.elements.each_with_object(attrs) do |mapping_rule, hash|
             next if options[:except]&.include?(mapping_rule.to)
 
-            if mapping_rule.namespace
+            if mapping_rule.namespace && mapping_rule.prefix
               hash["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end
           end

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

@@ -16,7 +16,8 @@ module Lutaml
           children = [],
           text = nil,
           parent_document: nil,
-          namespace_prefix: nil
+          namespace_prefix: nil,
+          default_namespace: nil
         )
           @name = extract_name(name)
           @namespace_prefix = namespace_prefix || extract_namespace_prefix(name)
@@ -24,11 +25,20 @@ module Lutaml
           @children = children
           @text = text
           @parent_document = parent_document
+          @default_namespace = default_namespace
         end
 
         def name
-          if namespace_prefix
-            "#{namespace_prefix}:#{@name}"
+          return @name unless namespace_prefix
+
+          "#{namespace_prefix}:#{@name}"
+        end
+
+        def namespaced_name
+          if namespaces[namespace_prefix] && !text?
+            "#{namespaces[namespace_prefix].uri}:#{@name}"
+          elsif @default_namespace && !text?
+            "#{@default_namespace}:#{name}"
           else
             @name
           end

data/lib/lutaml/model/xml_mapping.rb

@@ -6,7 +6,8 @@ module Lutaml
       attr_reader :root_element,
                   :namespace_uri,
                   :namespace_prefix,
-                  :mixed_content
+                  :mixed_content,
+                  :ordered
 
       def initialize
         @elements = {}
@@ -16,10 +17,12 @@ module Lutaml
       end
 
       alias mixed_content? mixed_content
+      alias ordered? ordered
 
-      def root(name, mixed: false)
+      def root(name, mixed: false, ordered: false)
         @root_element = name
         @mixed_content = mixed
+        @ordered = ordered || mixed # mixed contenet will always be ordered
       end
 
       def prefixed_root
@@ -49,17 +52,19 @@ module Lutaml
       )
         validate!(name, to, with)
 
-        @elements[name] = XmlMappingRule.new(
+        rule = XmlMappingRule.new(
           name,
           to: to,
           render_nil: render_nil,
           with: with,
           delegate: delegate,
           namespace: namespace,
+          default_namespace: namespace_uri,
           prefix: prefix,
           namespace_set: namespace_set != false,
           prefix_set: prefix_set != false,
         )
+        @elements[rule.namespaced_name] = rule
       end
 
       def map_attribute(
@@ -75,7 +80,7 @@ module Lutaml
       )
         validate!(name, to, with)
 
-        @attributes[name] = XmlMappingRule.new(
+        rule = XmlMappingRule.new(
           name,
           to: to,
           render_nil: render_nil,
@@ -83,9 +88,11 @@ module Lutaml
           delegate: delegate,
           namespace: namespace,
           prefix: prefix,
+          default_namespace: namespace_uri,
           namespace_set: namespace_set != false,
           prefix_set: prefix_set != false,
         )
+        @attributes[rule.namespaced_name] = rule
       end
 
       # rubocop:enable Metrics/ParameterLists

data/lib/lutaml/model/xml_mapping_rule.rb

@@ -15,7 +15,8 @@ module Lutaml
         prefix: nil,
         mixed_content: false,
         namespace_set: false,
-        prefix_set: false
+        prefix_set: false,
+        default_namespace: nil
       )
         super(
           name,
@@ -26,6 +27,7 @@ module Lutaml
           mixed_content: mixed_content,
           namespace_set: namespace_set,
           prefix_set: prefix_set,
+          default_namespace: default_namespace
         )
 
         @namespace = if namespace.to_s == "inherit"

metadata

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