lutaml-model 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30487a24277470ff7b3d12193e46262b0fc1cac85461224ed98749c8b6de5104
-  data.tar.gz: a161a8e5f83a10ec5db5b77a0d5a0abe72b629d0900a4ab040414c2a02c22725
+  metadata.gz: 12f6b0d44c864c56f2573bae9a712485e0b266120fe53f342671b8cb144ce022
+  data.tar.gz: 3facbc5cc6ef8149f1628415f3d511c2e010de28f8ab5968f2e436eb6aa41b39
 SHA512:
-  metadata.gz: 2a805f81f93bc0dcb983d83e7f7fc870989f84fb25434de7edee18269c1b96b8572516132e17e3db2e188075e985cb8219ec84257fd380c7abfe4b65b32116af
-  data.tar.gz: 0243f89d6fb6c5466e29500e810a077096e260b51d53a8a23db7918c7b2d57dc30a9757dd00814a2c497dd552e39bd17e92729c509670dde555a0b508a77013b
+  metadata.gz: 0157ca6aa7a9e0e0368fd1da623068670d033a54385b91aa45082412512f5ee1643d72da168d5b68fdef531034f49363417dbfce31c4b47452c8f1d0136d839d
+  data.tar.gz: cf6c69e91f9eb13275a845ee4253809cc60599527a26f28d13942fa26b10ce65bfbc6a6fed8fbc946a721a1d07edd8b98289447c668f7d8cba6dc3cd001bc85b

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-08-27 06:48:03 UTC using RuboCop version 1.65.1.
+# on 2024-09-04 07:55:32 UTC using RuboCop version 1.66.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
@@ -14,27 +14,14 @@ Gemspec/RequireMFA:
   Exclude:
     - 'lutaml-model.gemspec'
 
-# Offense count: 57
+# Offense count: 62
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Exclude:
-    - 'lib/lutaml/model/cli.rb'
-    - 'lib/lutaml/model/comparable_model.rb'
-    - 'lib/lutaml/model/serialize.rb'
-    - 'lib/lutaml/model/type.rb'
-    - 'lib/lutaml/model/utils.rb'
-    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
-    - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
-    - 'lib/lutaml/model/xml_adapter/xml_document.rb'
-    - 'spec/lutaml/model/comparable_model_spec.rb'
-    - 'spec/lutaml/model/custom_serialization_spec.rb'
-    - 'spec/lutaml/model/delegation_spec.rb'
-    - 'spec/lutaml/model/schema/json_schema_spec.rb'
-    - 'spec/lutaml/model/serializable_spec.rb'
+  Enabled: false
 
-# Offense count: 4
+# Offense count: 10
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:
@@ -43,8 +30,9 @@ Lint/ConstantDefinitionInBlock:
     - 'spec/lutaml/model/schema/relaxng_schema_spec.rb'
     - 'spec/lutaml/model/schema/xsd_schema_spec.rb'
     - 'spec/lutaml/model/schema/yaml_schema_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
 
-# Offense count: 28
+# Offense count: 29
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
@@ -57,11 +45,11 @@ Metrics/AbcSize:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 43
+  Max: 42
 
 # Offense count: 22
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
@@ -96,7 +84,7 @@ Metrics/PerceivedComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -104,8 +92,9 @@ RSpec/ContextWording:
     - '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'
 
-# Offense count: 76
+# Offense count: 86
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 57
@@ -116,13 +105,14 @@ RSpec/IndexedLet:
   Exclude:
     - 'spec/address_spec.rb'
 
-# Offense count: 12
+# Offense count: 18
 RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/lutaml/model/schema/json_schema_spec.rb'
     - 'spec/lutaml/model/schema/relaxng_schema_spec.rb'
     - 'spec/lutaml/model/schema/xsd_schema_spec.rb'
     - 'spec/lutaml/model/schema/yaml_schema_spec.rb'
+    - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
 
 # Offense count: 4
 RSpec/MultipleDescribes:
@@ -132,18 +122,19 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 70
+# Offense count: 75
 RSpec/MultipleExpectations:
-  Max: 10
+  Max: 11
 
 # Offense count: 11
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 9
 
-# Offense count: 3
+# Offense count: 4
 RSpec/PendingWithoutReason:
   Exclude:
+    - 'spec/lutaml/model/mixed_content_spec.rb'
     - 'spec/lutaml/model/xml_adapter/oga_adapter_spec.rb'
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'

data/README.adoc

@@ -652,6 +652,7 @@ end
 
 ==== Namespaces
 
+[[root-namespace]]
 ===== Namespace at root
 
 The `namespace` method in the `xml` block sets the namespace for the root
@@ -659,6 +660,7 @@ element.
 
 Syntax:
 
+.Setting default namespace at the root element
 [source,ruby]
 ----
 xml do
@@ -666,6 +668,15 @@ xml do
 end
 ----
 
+.Setting a prefixed namespace at the root element
+[source,ruby]
+----
+xml do
+  namespace 'http://example.com/namespace', 'prefix'
+end
+----
+
+
 .Using the `namespace` method to set the namespace for the root element
 [example]
 ====
@@ -698,10 +709,43 @@ end
 ----
 ====
 
+.Using the `namespace` method to set a prefixed namespace for the root element
+[example]
+====
+[source,ruby]
+----
+class Ceramic < Lutaml::Model::Serializable
+  attribute :type, :string
+  attribute :glaze, :string
+
+  xml do
+    root 'Ceramic'
+    namespace 'http://example.com/ceramic', 'cer'
+    map_element 'Type', to: :type
+    map_element 'Glaze', to: :glaze
+  end
+end
+----
+
+[source,xml]
+----
+<cer:Ceramic xmlns='http://example.com/ceramic'><cer:Type>Porcelain</cer:Type><cer:Glaze>Clear</cer:Glaze></cer:Ceramic>
+----
+
+[source,ruby]
+----
+> Ceramic.from_xml(xml_file)
+> #<Ceramic:0x0000000104ac7240 @type="Porcelain", @glaze="Clear">
+> Ceramic.new(type: "Porcelain", glaze: "Clear").to_xml
+> #<cer:Ceramic xmlns="http://example.com/ceramic"><cer:Type>Porcelain</cer:Type><cer:Glaze>Clear</cer:Glaze></cer:Ceramic>
+----
+====
+
+
 ===== Namespace on attribute
 
-If the namespace is defined on an XML attribute, then that will be given
-priority over the one defined in the class.
+If the namespace is defined on a model attribute that already has a namespace,
+the mapped namespace will be given priority over the one defined in the class.
 
 Syntax:
 
@@ -725,6 +769,19 @@ In this example, `glz` will be used for `Glaze` if it is added inside the
 
 [source,ruby]
 ----
+class Ceramic < Lutaml::Model::Serializable
+  attribute :type, :string
+  attribute :glaze, Glaze
+
+  xml do
+    root 'Ceramic'
+    namespace 'http://example.com/ceramic'
+
+    map_element 'Type', to: :type
+    map_element 'Glaze', to: :glaze, namespace: 'http://example.com/glaze', prefix: "glz"
+  end
+end
+
 class Glaze < Lutaml::Model::Serializable
   attribute :color, :string
   attribute :temperature, :integer
@@ -737,18 +794,6 @@ class Glaze < Lutaml::Model::Serializable
     map_element 'temperature', to: :temperature
   end
 end
-
-class Ceramic < Lutaml::Model::Serializable
-  attribute :type, :string
-  attribute :glaze, Glaze
-
-  xml do
-    root 'Ceramic'
-    map_element 'Type', to: :type
-    map_element 'Glaze', to: :glaze, namespace: 'http://example.com/glaze', prefix: "glz"
-    map_attribute 'xmlns', to: :namespace, namespace: 'http://example.com/ceramic'
-  end
-end
 ----
 
 [source,xml]
@@ -764,6 +809,11 @@ end
 
 [source,ruby]
 ----
+> # Using the original Glaze class namespace
+> Glaze.new(color: "Clear", temperature: 1050).to_xml
+> #<glaze:Glaze xmlns="http://example.com/old_glaze"><color>Clear</color><temperature>1050</temperature></glaze:Glaze>
+
+> # Using the Ceramic class namespace for Glaze
 > Ceramic.from_xml(xml_file)
 > #<Ceramic:0x0000000104ac7240 @type="Porcelain", @glaze=#<Glaze:0x0000000104ac7240 @color="Clear", @temperature=1050>>
 > Ceramic.new(type: "Porcelain", glaze: Glaze.new(color: "Clear", temperature: 1050)).to_xml
@@ -800,7 +850,7 @@ class Ceramic < Lutaml::Model::Serializable
 
   xml do
     root 'Ceramic'
-    namespace 'http://example.com/ceramic', prefix: 'cera'
+    namespace 'http://example.com/ceramic', 'cera'
     map_element 'Type', to: :type, namespace: :inherit
     map_element 'Glaze', to: :glaze
     map_attribute 'color', to: :color, namespace: 'http://example.com/color', prefix: 'clr'
@@ -810,13 +860,13 @@ end
 
 [source,xml]
 ----
-<Ceramic
+<cera:Ceramic
   xmlns:cera='http://example.com/ceramic'
   xmlns:clr='http://example.com/color'
   clr:color="navy-blue">
   <cera:Type>Porcelain</cera:Type>
   <Glaze>Clear</Glaze>
-</Ceramic>
+</cera:Ceramic>
 ----
 
 [source,ruby]
@@ -824,20 +874,18 @@ end
 > Ceramic.from_xml(xml_file)
 > #<Ceramic:0x0000000104ac7240 @type="Porcelain", @glaze="Clear", @color="navy-blue">
 > Ceramic.new(type: "Porcelain", glaze: "Clear", color: "navy-blue").to_xml
-> #<Ceramic xmlns:cera="http://example.com/ceramic"
+> #<cera:Ceramic xmlns:cera="http://example.com/ceramic"
   # xmlns:clr='http://example.com/color'
   # clr:color="navy-blue">
   #  <cera:Type>Porcelain</cera:Type>
   #  <Glaze>Clear</Glaze>
-  # </Ceramic>
+  # </cera:Ceramic>
 ----
 ====
 
 [[mixed-content]]
 ==== Mixed content
 
-===== General
-
 In XML there can be tags that contain content mixed with other tags and where
 whitespace is significant, such as to represent rich text.
 
@@ -857,9 +905,8 @@ To map this to Lutaml::Model we can use the `mixed` option in either way:
 NOTE: This feature is not supported by Shale.
 
 
-===== Specifying the `mixed` option at `root`
-
-This will always treat the content of the element itself as mixed content.
+To specify mixed content, the `mixed: true` option needs to be set at the
+`xml` block's `root` method.
 
 Syntax:
 
@@ -876,7 +923,7 @@ end
 [source,ruby]
 ----
 class Paragraph < Lutaml::Model::Serializable
-  attribute :bold, :string
+  attribute :bold, :string, collection: true # allows multiple bold tags
   attribute :italic, :string
 
   xml do
@@ -900,57 +947,6 @@ end
 TODO: How to create mixed content from `#new`?
 
 
-===== Specifying the `mixed` option when referencing a model
-
-This will only treat the content of the referenced model as mixed content if the
-`mixed: true` is added when referencing it.
-
-Syntax:
-
-[source,ruby]
-----
-xml do
-  map_element 'xml_element_name', to: :name_of_attribute, mixed: true
-end
-----
-
-.Applying `mixed` to treat an inner element as mixed content
-[example]
-====
-[source,ruby]
-----
-class Paragraph < Lutaml::Model::Serializable
-  attribute :bold, :string
-  attribute :italic, :string
-
-  xml do
-    root 'p'
-
-    map_element 'bold', to: :bold
-    map_element 'i', to: :italic
-  end
-end
-
-class Description < Lutaml::Model::Serializable
-  attribute :paragraph, Paragraph
-
-  xml do
-    root 'description'
-
-    map_element 'p', to: :paragraph, mixed: true
-  end
-end
-----
-
-[source,ruby]
-----
-> Description.from_xml("<description><p>My name is <bold>John Doe</bold>, and I'm <i>28</i> years old</p></description>")
-> #<Description:0x0000000104ac7240 @paragraph=#<Paragraph:0x0000000104ac7240 @bold="John Doe", @italic="28">>
-> Description.new(paragraph: Paragraph.new(bold: "John Doe", italic: "28")).to_xml
-> #<description><p>My name is <bold>John Doe</bold>, and I'm <i>28</i> years old</p></description>
-----
-====
-
 
 === Key value data models
 
@@ -1579,7 +1575,7 @@ Lutaml::Model::Config.configure do |config|
 end
 ----
 
-You can also provide the adapter type by using symbols like 
+You can also provide the adapter type by using symbols like
 
 [source,ruby]
 ----
@@ -1765,6 +1761,11 @@ differences in implementation.
 
 4+h| XML features
 
+| <<root-namespace,XML default namespace>>
+| Yes. Supports `<root xmlns='http://example.com'>` through the `namespace` option without prefix.
+| No. Only supports `<root xmlns:prefix='http://example.com'>`.
+|
+
 | XML mixed content support
 | Yes. Supports the following kind of XML through <<mixed-content,mixed content>> support.
 

data/lib/lutaml/model/serialize.rb

@@ -276,7 +276,10 @@ module Lutaml
                     end
 
             if rule.custom_methods[:from]
-              value = new.send(rule.custom_methods[:from], instance, value) if value && !value.empty?
+              if value && !value.empty?
+                value = new.send(rule.custom_methods[:from], instance,
+                                 value)
+              end
               next
             end
 

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.8"
+    VERSION = "0.3.9"
   end
 end

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

@@ -17,9 +17,14 @@ module Lutaml
 
           def initialize(xml)
             @xml = xml
+            @current_namespace = nil
           end
 
           def create_element(name, attributes = {})
+            if @current_namespace && !name.start_with?("#{@current_namespace}:")
+              name = "#{@current_namespace}:#{name}"
+            end
+
             if block_given?
               xml.element(name, attributes) do |element|
                 yield(self.class.new(element))
@@ -36,6 +41,8 @@ module Lutaml
           def create_and_add_element(element_name, prefix: nil, attributes: {})
             prefixed_name = if prefix
                               "#{prefix}:#{element_name}"
+                            elsif @current_namespace && !element_name.start_with?("#{@current_namespace}:")
+                              "#{@current_namespace}:#{element_name}"
                             else
                               element_name
                             end
@@ -47,6 +54,8 @@ module Lutaml
             else
               xml.element(prefixed_name, attributes)
             end
+
+            @current_namespace = nil
           end
 
           def <<(text)
@@ -59,9 +68,10 @@ module Lutaml
 
           # Add XML namespace to document
           #
-          # Ox doesn't support XML namespaces so this method does nothing.
-          def add_namespace_prefix(_prefix)
-            # :noop:
+          # Ox doesn't support XML namespaces so we only save the
+          # current namespace prefix to add it to the element's name later.
+          def add_namespace_prefix(prefix)
+            @current_namespace = prefix
             self
           end
 

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

@@ -20,6 +20,8 @@ module Lutaml
           elsif ordered?(@root, options)
             build_ordered_element(builder, @root, options)
           else
+            mapper_class = options[:mapper_class] || @root.class
+            options[:xml_attributes] = build_namespace_attributes(mapper_class)
             build_element(builder, @root, options)
           end
 
@@ -46,6 +48,7 @@ module Lutaml
               curr_index = index_hash[name] += 1
 
               element_rule = xml_mapping.find_by_name(name)
+              next if element_rule.nil?
 
               attribute_def = attribute_definition_for(element, element_rule,
                                                        mapper_class: mapper_class)

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

@@ -160,10 +160,10 @@ module Lutaml
           prefixed_xml = xml.add_namespace_prefix(prefix)
           tag_name = options[:tag_name] || xml_mapping.root_element
 
-          xml.create_and_add_element(tag_name, prefix: prefix,
-                                               attributes: attributes) do
+          prefixed_xml.create_and_add_element(tag_name, prefix: prefix,
+                                                        attributes: attributes) do
             if options.key?(:namespace_prefix) && !options[:namespace_prefix]
-              xml.add_namespace_prefix(nil)
+              prefixed_xml.add_namespace_prefix(nil)
             end
 
             xml_mapping.elements.each do |element_rule|
@@ -177,7 +177,7 @@ module Lutaml
               value = [value] if attribute_def.collection? && !value.is_a?(Array)
 
               add_to_xml(
-                xml,
+                prefixed_xml,
                 element_rule.prefix,
                 value,
                 options.merge({ attribute: attribute_def, rule: element_rule }),
@@ -212,9 +212,11 @@ module Lutaml
 
           attrs = {}
 
-          if xml_mappings.namespace_prefix
-            attrs["xmlns:#{xml_mappings.namespace_prefix}"] =
-              xml_mappings.namespace_uri
+          if xml_mappings.namespace_uri
+            prefixed_name = ["xmlns",
+                             xml_mappings.namespace_prefix].compact.join(":")
+
+            attrs[prefixed_name] = xml_mappings.namespace_uri
           end
 
           xml_mappings.mappings.each do |mapping_rule|

data/lib/lutaml/model/xml_mapping.rb

@@ -44,8 +44,7 @@ module Lutaml
         delegate: nil,
         namespace: (namespace_set = false
                     nil),
-        prefix: nil,
-        mixed: false
+        prefix: nil
       )
         @elements[name] = XmlMappingRule.new(
           name,
@@ -55,7 +54,6 @@ module Lutaml
           delegate: delegate,
           namespace: namespace,
           prefix: prefix,
-          mixed_content: mixed,
           namespace_set: namespace_set != false,
         )
       end

data/lutaml-model.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
   end
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
+  spec.add_dependency "bigdecimal"
   spec.add_dependency "thor"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-model
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement