lutaml-model 0.3.29 → 0.3.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba70c8a3fca206b3109603109812019773027580c47b2e3615d873df6e0ce2d
-  data.tar.gz: 21313fbfb52c29c620eb1020672d337689eed963c25fe56c20baeef139e569b5
+  metadata.gz: cca2f0b92a3e71807ed2201909e02ea5877dc1468c34c62d887d523962e63968
+  data.tar.gz: 56fe25dc8f9229d2bcabe1315c88f0f7d8fb3a3ca5f01b78b0e6494fb65ebc75
 SHA512:
-  metadata.gz: 274739542b8473ae58b4fc6b78e1152aaef604a55f3c9db0ec5678743573d683b4afdd2429d97d6a24c03fdb2c14a72904bf4e057f480e6bafc635a21fde085a
-  data.tar.gz: b1a7ad49313463676b3afe8732f94ed8ab37f79935f33449c70011bd8a8449934425aa27b9dd25d2a7e25a064afa1e665bf95f8b2eac4ec7cd63be4bcfdb7b8d
+  metadata.gz: a6d19950a00e397146f8a8cfc8eeeb0e3c965f9fb7f5cb3bb5518cf636505f31ec72750552385b533d410eec51c6e325d0d57070fca52189ff00a48c8380c156
+  data.tar.gz: b7d55249da057ffe7f222c997ae4f628c7dd5acdeee9d7a1a5919f7f6d034ac5342b961696797029233dcd931a7db82be67f00f89a5b78463c3a7c101fbc3e4f

data/.github/workflows/dependent-repos.json

@@ -0,0 +1,15 @@
+{
+  "repo": [
+    "lutaml/genericode",
+    "lutaml/ogc-gml",
+    "metanorma/modspec-ruby",
+    "metanorma/rfcxml",
+    "metanorma/niso-jats",
+    "metanorma/sts-ruby",
+    "lutaml/metaschema",
+    "glossarist/termium",
+    "lutaml/oasis-etm",
+    "lutaml/ali",
+    "lutaml/reqif"
+  ]
+}

data/.github/workflows/dependent-tests.yml

@@ -0,0 +1,14 @@
+name: dependent-gems-test
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ v* ]
+  pull_request:
+  workflow_dispatch:
+  repository_dispatch:
+    types: [ release-passed ]
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/dependent-rake.yml@main

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-11-25 13:01:09 UTC using RuboCop version 1.66.1.
+# on 2024-12-03 11:13:42 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: 185
+# Offense count: 224
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -51,7 +51,7 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 47
+  Max: 46
 
 # Offense count: 28
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
@@ -65,7 +65,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 55
+# Offense count: 54
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 46
@@ -97,7 +97,15 @@ RSpec/ContextWording:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_mapping_spec.rb'
 
-# Offense count: 127
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/lutaml/model/xml_mapping_spec.rb'
+
+# Offense count: 133
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 54
@@ -127,7 +135,7 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 153
+# Offense count: 157
 RSpec/MultipleExpectations:
   Max: 14
 
@@ -136,7 +144,7 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Max: 9
 
-# Offense count: 11
+# Offense count: 15
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 4

data/lib/lutaml/model/json_adapter/json_document.rb

@@ -7,7 +7,7 @@ module Lutaml
     module JsonAdapter
       # Base class for JSON documents
       class JsonDocument < JsonObject
-        def self.parse(json)
+        def self.parse(json, _options = {})
           raise NotImplementedError, "Subclasses must implement `parse`."
         end
 

data/lib/lutaml/model/json_adapter/multi_json_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module JsonAdapter
       class MultiJsonAdapter < JsonDocument
-        def self.parse(json)
+        def self.parse(json, _options = {})
           data = MultiJson.load(json)
           new(data)
         end

data/lib/lutaml/model/json_adapter/standard_json_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module JsonAdapter
       class StandardJsonAdapter < JsonDocument
-        def self.parse(json)
+        def self.parse(json, _options = {})
           JSON.parse(json, create_additions: false)
         end
 

data/lib/lutaml/model/serialize.rb

@@ -51,6 +51,7 @@ module Lutaml
           Utils.add_boolean_accessor_if_not_defined(klass, :ordered)
           Utils.add_boolean_accessor_if_not_defined(klass, :mixed)
           Utils.add_accessor_if_not_defined(klass, :element_order)
+          Utils.add_accessor_if_not_defined(klass, :encoding)
 
           Utils.add_method_if_not_defined(klass,
                                           :using_default_for) do |attribute_name|
@@ -101,23 +102,22 @@ module Lutaml
             end
           end
 
-          define_method(:"from_#{format}") do |data|
+          define_method(:"from_#{format}") do |data, options = {}|
             adapter = Lutaml::Model::Config.send(:"#{format}_adapter")
 
-            doc = adapter.parse(data)
-            public_send(:"of_#{format}", doc)
+            doc = adapter.parse(data, options)
+            public_send(:"of_#{format}", doc, options)
           end
 
-          define_method(:"of_#{format}") do |doc|
+          define_method(:"of_#{format}") do |doc, options = {}|
             if doc.is_a?(Array)
-              return doc.map do |item|
-                       send(:"of_#{format}", item)
-                     end
+              return doc.map { |item| send(:"of_#{format}", item) }
             end
 
             if format == :xml
               doc_hash = doc.parse_element(doc.root, self, :xml)
-              apply_mappings(doc_hash, format)
+              options[:encoding] = doc.encoding
+              apply_mappings(doc_hash, format, options)
             else
               apply_mappings(doc.to_h, format)
             end
@@ -315,6 +315,7 @@ module Lutaml
         end
 
         def apply_xml_mapping(doc, instance, options = {})
+          instance.encoding = options[:encoding]
           return instance unless doc
 
           if options[:default_namespace].nil?
@@ -347,6 +348,8 @@ module Lutaml
           mappings.each do |rule|
             raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
 
+            attr = attribute_for_rule(rule)
+
             value = if rule.raw_mapping?
                       doc.node.inner_xml
                     elsif rule.content_mapping?
@@ -355,10 +358,10 @@ module Lutaml
                       doc.fetch(rule.namespaced_name(options[:default_namespace]))
                     else
                       defaults_used << rule.to
-                      rule.to_value_for(instance)
+                      attr&.default || rule.to_value_for(instance)
                     end
 
-            value = normalize_xml_value(value, rule, options)
+            value = normalize_xml_value(value, rule, attr, options)
             rule.deserialize(instance, value, attributes, self)
           end
 
@@ -399,9 +402,7 @@ module Lutaml
           instance
         end
 
-        def normalize_xml_value(value, rule, options = {})
-          attr = attribute_for_rule(rule)
-
+        def normalize_xml_value(value, rule, attr, options = {})
           value = [value].compact if attr&.collection? && !value.is_a?(Array)
 
           value = if value.is_a?(Array)
@@ -459,7 +460,7 @@ module Lutaml
         end
       end
 
-      attr_accessor :element_order, :schema_location
+      attr_accessor :element_order, :schema_location, :encoding
       attr_writer :ordered, :mixed
 
       def initialize(attrs = {})
@@ -548,6 +549,7 @@ module Lutaml
                                                             options)
                            end
 
+          options[:parse_encoding] = encoding if encoding
           adapter.new(representation).public_send(:"to_#{format}", options)
         end
       end

data/lib/lutaml/model/toml_adapter/toml_document.rb

@@ -7,7 +7,7 @@ module Lutaml
     module TomlAdapter
       # Base class for TOML documents
       class TomlDocument < TomlObject
-        def self.parse(toml)
+        def self.parse(toml, _options = {})
           raise NotImplementedError, "Subclasses must implement `parse`."
         end
 

data/lib/lutaml/model/toml_adapter/toml_rb_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module TomlAdapter
       class TomlRbAdapter < TomlDocument
-        def self.parse(toml)
+        def self.parse(toml, _options = {})
           data = TomlRB.parse(toml)
           new(data)
         end

data/lib/lutaml/model/toml_adapter/tomlib_adapter.rb

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module TomlAdapter
       class TomlibAdapter < TomlDocument
-        def self.parse(toml)
+        def self.parse(toml, _options = {})
           data = Tomlib.load(toml)
           new(data)
         end

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.29"
+    VERSION = "0.3.30"
   end
 end

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

@@ -51,6 +51,16 @@ module Lutaml
             end
           end
 
+          def add_xml_fragment(element, content)
+            if element.is_a?(self.class)
+              element = element.xml.parent
+            end
+
+            fragment = ::Nokogiri::XML::DocumentFragment.parse(content)
+
+            element.add_child(fragment)
+          end
+
           def add_text(element, text, cdata: false)
             return add_cdata(element, text) if cdata
 

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

@@ -66,10 +66,14 @@ module Lutaml
             xml.text(text)
           end
 
+          def add_xml_fragment(element, content)
+            element.raw(content)
+          end
+
           def add_text(element, text, cdata: false)
             return element.cdata(text) if cdata
 
-            element << text
+            element.text(text)
           end
 
           def add_cdata(element, value)

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

@@ -6,10 +6,10 @@ module Lutaml
   module Model
     module XmlAdapter
       class NokogiriAdapter < XmlDocument
-        def self.parse(xml)
-          parsed = Nokogiri::XML(xml)
+        def self.parse(xml, options = {})
+          parsed = Nokogiri::XML(xml, nil, options[:encoding])
           root = NokogiriElement.new(parsed.root)
-          new(root)
+          new(root, parsed.encoding)
         end
 
         def to_xml(options = {})
@@ -17,6 +17,8 @@ module Lutaml
 
           if options.key?(:encoding)
             builder_options[:encoding] = options[:encoding] unless options[:encoding].nil?
+          elsif options.key?(:parse_encoding)
+            builder_options[:encoding] = options[:parse_encoding]
           else
             builder_options[:encoding] = "UTF-8"
           end

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

@@ -5,7 +5,7 @@ module Lutaml
   module Model
     module XmlAdapter
       class OgaAdapter < XmlDocument
-        def self.parse(xml)
+        def self.parse(xml, _options = {})
           parsed = Oga.parse_xml(xml)
           root = OgaElement.new(parsed)
           new(root)

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

@@ -6,23 +6,28 @@ module Lutaml
   module Model
     module XmlAdapter
       class OxAdapter < XmlDocument
-        def self.parse(xml)
+        def self.parse(xml, options = {})
+          Ox.default_options = Ox.default_options.merge(encoding: options[:encoding] || "UTF-8")
+
           parsed = Ox.parse(xml)
           root = OxElement.new(parsed)
-          new(root)
+          new(root, Ox.default_options[:encoding])
         end
 
         def to_xml(options = {})
-          builder = Builder::Ox.build
           builder_options = { version: options[:version] }
 
-          if options.key?(:encoding)
-            builder_options[:encoding] = options[:encoding] unless options[:encoding].nil?
-          else
-            builder_options[:encoding] = "UTF-8"
-          end
+          builder_options[:encoding] = if options.key?(:encoding)
+                                         options[:encoding]
+                                       elsif options.key?(:parse_encoding)
+                                         options[:parse_encoding]
+                                       else
+                                         "UTF-8"
+                                       end
+
+          builder = Builder::Ox.build
+          builder.xml.instruct(:xml, encoding: options[:parse_encoding])
 
-          builder.xml.instruct(:xml, builder_options)
           if @root.is_a?(Lutaml::Model::XmlAdapter::OxElement)
             @root.build_xml(builder)
           elsif ordered?(@root, options)
@@ -34,7 +39,12 @@ module Lutaml
           end
 
           xml_data = builder.xml.to_s
-          options[:declaration] ? xml_data : xml_data.sub(/\A<\?xml[^>]*\?>\n?/, "")
+          if builder_options[:encoding] && xml_data.valid_encoding?
+            xml_data = xml_data.encode(builder_options[:encoding])
+          end
+
+          stripped_data = xml_data.lines.drop(1).join
+          options[:declaration] ? declaration(options) + stripped_data : stripped_data
         end
 
         private
@@ -145,6 +155,11 @@ module Lutaml
           build_xml.xml.to_s
         end
 
+        def inner_xml
+          # Ox builder by default, adds a newline at the end, so `chomp` is used
+          children.map { |child| child.to_xml.chomp }.join
+        end
+
         def build_xml(builder = nil)
           builder ||= Builder::Ox.build
           attrs = build_attributes(self)

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

@@ -7,13 +7,14 @@ module Lutaml
   module Model
     module XmlAdapter
       class XmlDocument
-        attr_reader :root
+        attr_reader :root, :encoding
 
-        def initialize(root)
+        def initialize(root, encoding = nil)
           @root = root
+          @encoding = encoding
         end
 
-        def self.parse(xml)
+        def self.parse(xml, _options = {})
           raise NotImplementedError, "Subclasses must implement `parse`."
         end
 
@@ -150,6 +151,8 @@ module Lutaml
               value,
               options.merge({ rule: rule, attribute: attribute }),
             )
+          elsif rule.raw_mapping?
+            xml.add_xml_fragment(xml, value)
           elsif rule.prefix_set?
             xml.create_and_add_element(rule.name, prefix: prefix) do
               add_value(xml, value, attribute, cdata: rule.cdata)
@@ -186,10 +189,6 @@ module Lutaml
           attributes = build_attributes(element,
                                         xml_mapping, options).merge(attributes)&.compact
 
-          if element.respond_to?(:schema_location) && element.schema_location
-            attributes.merge!(element.schema_location.to_xml_attributes)
-          end
-
           prefix = if options.key?(:namespace_prefix)
                      options[:namespace_prefix]
                    elsif xml_mapping.namespace_prefix
@@ -210,7 +209,8 @@ module Lutaml
                                                  xml)
             end
 
-            xml_mapping.elements.each do |element_rule|
+            mappings = xml_mapping.elements + [xml_mapping.raw_mapping].compact
+            mappings.each do |element_rule|
               attribute_def = attribute_definition_for(element, element_rule,
                                                        mapper_class: mapper_class)
 
@@ -234,20 +234,9 @@ module Lutaml
 
             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, cdata: rule.cdata)
-        end
-
         def process_content_mapping(element, content_rule, xml)
           return unless content_rule
 
@@ -343,7 +332,7 @@ module Lutaml
                     {}
                   end
 
-          if element.respond_to?(:schema_location) && element.schema_location
+          if element.respond_to?(:schema_location) && element.schema_location && !options[:except]&.include?(:schema_location)
             attrs.merge!(element.schema_location.to_xml_attributes)
           end
 
@@ -355,10 +344,9 @@ module Lutaml
               hash["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end
 
-            if render_element?(mapping_rule, element,
-                               mapping_rule.to_value_for(element))
-              hash[mapping_rule.prefixed_name] =
-                mapping_rule.to_value_for(element)
+            value = mapping_rule.to_value_for(element)
+            if render_element?(mapping_rule, element, value)
+              hash[mapping_rule.prefixed_name] = value ? value.to_s : value
             end
           end
 

data/lib/lutaml/model/yaml_adapter/standard_yaml_adapter.rb

@@ -14,7 +14,7 @@ module Lutaml
                               PERMITTED_CLASSES_BASE
                             end.freeze
 
-        def self.parse(yaml)
+        def self.parse(yaml, _options = {})
           YAML.safe_load(yaml, permitted_classes: PERMITTED_CLASSES)
         end
 

data/lib/lutaml/model/yaml_adapter/yaml_document.rb

@@ -7,7 +7,7 @@ module Lutaml
     module YamlAdapter
       # Base class for YAML documents
       class YamlDocument < YamlObject
-        def self.parse(yaml)
+        def self.parse(yaml, _options = {})
           raise NotImplementedError, "Subclasses must implement `parse`."
         end
 

data/spec/fixtures/xml/latin_encoding.xml

@@ -0,0 +1,5 @@
+<note>
+    <to>Jos�</to>
+    <from>M�ller</from>
+    <heading>Reminder</heading>
+</note>

data/spec/fixtures/xml/shift_jis.xml

@@ -0,0 +1,4 @@
+<root>
+  <FieldName>�菑���p���P</FieldName>
+  <FieldName>123456</FieldName>
+</root>

data/spec/lutaml/model/defaults_spec.rb

@@ -105,6 +105,29 @@ module DefaultsSpec
       map "opacity", to: :opacity, render_default: false
     end
   end
+
+  # Class for testing render_default: true with custom model
+  class Lang
+    attr_accessor :lang, :content
+  end
+
+  class CustomModelWithDefaultValue < Lutaml::Model::Serializable
+    model Lang
+
+    attribute :lang, :string, default: -> { "en" }
+    attribute :content, :string, default: -> { "default value not render when render_default is false" }
+
+    xml do
+      root "CustomModelWithDefaultValue"
+      map_attribute "lang", to: :lang, render_default: true
+      map_content to: :content, render_default: false
+    end
+
+    key_value do
+      map "lang", to: :lang, render_default: true
+      map "content", to: :content, render_default: false
+    end
+  end
 end
 
 RSpec.describe DefaultsSpec::Glaze do
@@ -125,6 +148,13 @@ RSpec.describe DefaultsSpec::Glaze do
       expect(default_model.manufacturer).to eq("example@glazes.com")
       expect(default_model.type).to eq("stoneware")
     end
+
+    it "contains the default value in instance" do
+      instance = DefaultsSpec::CustomModelWithDefaultValue.new
+
+      expect(instance.content).to eq("default value not render when render_default is false")
+      expect(instance.lang).to eq("en")
+    end
   end
 
   describe "Default value rendering behavior" do
@@ -155,6 +185,15 @@ RSpec.describe DefaultsSpec::Glaze do
           expect(xml).to include("<Opacity>Opaque</Opacity>")
           expect(xml).to include("<FiringTime>60</FiringTime>")
         end
+
+        it "serializes when render_default is true with custom model" do
+          parsed = DefaultsSpec::CustomModelWithDefaultValue.from_xml "<CustomModelWithDefaultValue>English</CustomModelWithDefaultValue>"
+          expect(parsed.lang).to eq("en")
+          expect(parsed.content).to eq("English")
+
+          serialized = DefaultsSpec::CustomModelWithDefaultValue.to_xml(parsed)
+          expect(serialized).to eq("<CustomModelWithDefaultValue lang=\"en\">English</CustomModelWithDefaultValue>")
+        end
       end
 
       context "when value is not default" do
@@ -200,6 +239,15 @@ RSpec.describe DefaultsSpec::Glaze do
           expect(json["opacity"]).to eq("Opaque")
           expect(json["firingTime"]).to eq(60)
         end
+
+        it "serializes when render_default is true with custom model" do
+          parsed = DefaultsSpec::CustomModelWithDefaultValue.from_json('{"content": "content"}')
+          expect(parsed.lang).to eq("en")
+          expect(parsed.content).to eq("content")
+
+          serialized = DefaultsSpec::CustomModelWithDefaultValue.to_json(parsed)
+          expect(serialized).to eq('{"lang":"en","content":"content"}')
+        end
       end
 
       context "when value is not default" do
@@ -217,5 +265,31 @@ RSpec.describe DefaultsSpec::Glaze do
         end
       end
     end
+
+    context "with YAML serialization" do
+      context "when value is default" do
+        it "serializes when render_default is true with custom model" do
+          parsed = DefaultsSpec::CustomModelWithDefaultValue.from_yaml("---\ncontent: content")
+          expect(parsed.lang).to eq("en")
+          expect(parsed.content).to eq("content")
+
+          serialized = DefaultsSpec::CustomModelWithDefaultValue.to_yaml(parsed)
+          expect(serialized).to eq("---\nlang: en\ncontent: content\n")
+        end
+      end
+    end
+
+    context "with TOML serialization" do
+      context "when value is default" do
+        it "serializes when render_default is true with custom model" do
+          parsed = DefaultsSpec::CustomModelWithDefaultValue.from_toml("content = 'content'")
+          expect(parsed.lang).to eq("en")
+          expect(parsed.content).to eq("content")
+
+          serialized = DefaultsSpec::CustomModelWithDefaultValue.to_toml(parsed)
+          expect(serialized).to eq("content = \"content\"\nlang = \"en\"\n")
+        end
+      end
+    end
   end
 end