lutaml-model 0.3.20 → 0.3.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab2e14b0b68874c47f728f68e7269e1347ab0997d005f93f16b16e897ba386d
-  data.tar.gz: 31238907ad9f6f969e0a557c85207136b9f49b335494d5d2a2dc6552261b0bab
+  metadata.gz: 3d740eaaa52ff7479fc3e0f23aa3fb308bd8b61f820ac22f036b31f24d696989
+  data.tar.gz: '0294c66616f39e84e931b626f776ee555450ac962018bf3189200467761e2707'
 SHA512:
-  metadata.gz: dc788a5dca9293c258488278ac0617fd3658e16f520c75df304e70b5591832a1ae84ae5ee43d091539904e7a66aef0a03801ac21b997f7b2b2f5bdb99d31e7dd
-  data.tar.gz: 31026554dadcf54876140fee95c5a2bc4b847cee45e09022b6c5a018a2ea9ff2fa1f067a515acf7cacb880e470935d3e28b34a773d19aae9723a5542c6a55a8a
+  metadata.gz: 56675b27dfbf1fa77986f5793f48dd8f5b53b69d5fa989209f79c1f2827ee0ed46eeeeecaed72904be2053a12c4653dab5d06dd0b1401754a06e9a0a9db8fc0f
+  data.tar.gz: cedbee96c00a6d43065df43acc8ee7d5262bd03265fda81fc85698c1abb7c00f0989c7cc9d1afe1f5038b4323e886adadd0609250dd9f952e2e1b33fcc9b7fee

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-10-30 07:34:33 UTC using RuboCop version 1.66.1.
+# on 2024-11-03 22:29:56 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: 146
+# Offense count: 124
 # 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: 5
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
@@ -67,7 +67,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 51
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 43
+  Max: 46
 
 # Offense count: 7
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
@@ -95,7 +95,7 @@ RSpec/ContextWording:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_mapping_spec.rb'
 
-# Offense count: 109
+# Offense count: 110
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 54

data/README.adoc

@@ -157,22 +157,27 @@ Syntax:
 attribute :name_of_attribute, {symbol | string | class}
 ----
 
+.Mapping between Lutaml::Model::Type classes, Ruby equivalents and serialization format types
 |===
-| String | Symbol | Class name | Actual value class
-
-| `String` | `:string` | `Lutaml::Model::Type::String` | `::String`
-| `Integer` | `:integer` | `Lutaml::Model::Type::Integer` | `::Integer`
-| `Float` | `:float` | `Lutaml::Model::Type::Float` | `::Float`
-| `Date` | `:date` | `Lutaml::Model::Type::Date` | `::Date`
-| `Time` | `:time` | `Lutaml::Model::Type::Time` | `::Time`
-| `DateTime` | `:date_time` | `Lutaml::Model::Type::DateTime` | `::DateTime`
-| `TimeWithoutDate` | `:time_without_date` | `Lutaml::Model::Type::TimeWithoutDate` | `::Time`
-| `Boolean` | `:boolean` | `Lutaml::Model::Type::Boolean` | `Boolean`
-| `Decimal` (optional) | `:decimal` | `Lutaml::Model::Type::Decimal` | `::BigDecimal`
-| `Hash` | `:hash` | `Lutaml::Model::Type::Hash` | `::Hash`
+| Lutaml::Model::Type   | Ruby Class               | XML               | JSON               | YAML        | Example Value
+
+| `:string`             | `String`                 | `xs:string`       | `string`           | `string`    | `"text"`
+| `:integer`            | `Integer`                | `xs:integer`      | `number`           | `integer`   | `42`
+| `:float`              | `Float`                  | `xs:decimal`      | `number`           | `float`     | `3.14`
+| `:boolean`            | `TrueClass`/`FalseClass` | `xs:boolean`      | `boolean`          | `boolean`   | `true/false`
+| `:date`               | `Date`                   | `xs:date`         | `string` (ISO8601) | `date`      | `"2024-01-01"`
+| `:time_without_date`  | `Time`                   | `xs:time`         | `string` (ISO8601) | `time`      | `"12:34:56"`
+| `:date_time`          | `DateTime`               | `xs:dateTime`     | `string` (ISO8601) | `timestamp` | `"2024-01-01T00:00:00Z"`
+| `:time`               | `Time`                   | `xs:dateTime`     | `string` (ISO8601) | `timestamp` | `"2024-01-01T00:00:00Z"`
+| `:decimal` (optional) | `BigDecimal`             | `xs:decimal`      | `number`           | `float`     | `123.45`
+| `:hash`               | `Hash`                   | complex element   | `object`           | `map`       | `{key: "value"}`
+| `class`               | Custom Class             | complex element   | `object`           | `map`       | `CustomObject`
+| `collection: true`    | `Array` of Type          | repeated elements | `array`            | `sequence`  | `[obj1, obj2]`
+// | `any`
 
 |===
 
+
 .Defining attributes with supported types via symbol, string and class
 [example]
 ====
@@ -538,8 +543,7 @@ For the following xml
     @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>
+    @ordered=nil>
 ----
 ====
 
@@ -1774,8 +1778,7 @@ end
    @name="Masterpiece: Vase",
    @ordered=nil,
    @size=12,
-   @description="A beautiful ceramic vase",
-   @validate_on_set=false>
+   @description="A beautiful ceramic vase">
 > puts CustomCeramic.new(name: "Vase", size: 12, description: "A beautiful vase").to_xml
 # <CustomCeramic Size="15">
 #   <Name>XML Masterpiece: Vase</Name>

data/lib/lutaml/model/attribute.rb

@@ -217,7 +217,8 @@ module Lutaml
 
       def validate_options!(options)
         if (invalid_opts = options.keys - ALLOWED_OPTIONS).any?
-          raise StandardError, "Invalid options given for `#{name}` #{invalid_opts}"
+          raise StandardError,
+                "Invalid options given for `#{name}` #{invalid_opts}"
         end
       end
 
@@ -225,7 +226,8 @@ module Lutaml
         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"
+        raise ArgumentError,
+              "Invalid type: #{type}, must be a Symbol, String or a Class"
       end
     end
   end

data/lib/lutaml/model/serialize.rb

@@ -32,7 +32,8 @@ module Lutaml
           @mappings ||= {}
           @attributes ||= {}
 
-          subclass.instance_variable_set(:@attributes, Utils.deep_dup(@attributes))
+          subclass.instance_variable_set(:@attributes,
+                                         Utils.deep_dup(@attributes))
           subclass.instance_variable_set(:@mappings, Utils.deep_dup(@mappings))
           subclass.instance_variable_set(:@model, subclass)
         end
@@ -51,17 +52,20 @@ module Lutaml
           Utils.add_boolean_accessor_if_not_defined(klass, :mixed)
           Utils.add_accessor_if_not_defined(klass, :element_order)
 
-          Utils.add_method_if_not_defined(klass, :using_default_for) do |attribute_name|
+          Utils.add_method_if_not_defined(klass,
+                                          :using_default_for) do |attribute_name|
             @using_default ||= {}
             @using_default[attribute_name] = true
           end
 
-          Utils.add_method_if_not_defined(klass, :value_set_for) do |attribute_name|
+          Utils.add_method_if_not_defined(klass,
+                                          :value_set_for) do |attribute_name|
             @using_default ||= {}
             @using_default[attribute_name] = false
           end
 
-          Utils.add_method_if_not_defined(klass, :using_default?) do |attribute_name|
+          Utils.add_method_if_not_defined(klass,
+                                          :using_default?) do |attribute_name|
             @using_default ||= {}
             !!@using_default[attribute_name]
           end
@@ -446,8 +450,7 @@ module Lutaml
       attr_writer :ordered, :mixed
 
       def initialize(attrs = {})
-        @validate_on_set = attrs.delete(:validate_on_set) || false
-        @using_default ||= {}
+        @using_default = {}
 
         return unless self.class.attributes
 

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.20"
+    VERSION = "0.3.22"
   end
 end

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

@@ -64,7 +64,7 @@ module Lutaml
           end
 
           def method_missing(method_name, *args, &block)
-            if block_given?
+            if block
               xml.public_send(method_name, *args, &block)
             else
               xml.public_send(method_name, *args)

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

@@ -128,12 +128,15 @@ module Lutaml
             )
           end
 
-          default_namespace = node.namespace&.href if root_node.nil?
+          if root_node.nil? && !node.namespace&.prefix
+            default_namespace = node.namespace&.href
+          end
 
           super(
             node,
             attributes,
-            parse_all_children(node, root_node: root_node || self, default_namespace: default_namespace),
+            parse_all_children(node, root_node: root_node || self,
+                                     default_namespace: default_namespace),
             node.text,
             parent_document: root_node,
             namespace_prefix: node.namespace&.prefix,
@@ -182,7 +185,8 @@ module Lutaml
 
         def parse_all_children(node, root_node: nil, default_namespace: nil)
           node.children.map do |child|
-            NokogiriElement.new(child, root_node: root_node, default_namespace: default_namespace)
+            NokogiriElement.new(child, root_node: root_node,
+                                       default_namespace: default_namespace)
           end
         end
 

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

@@ -77,7 +77,10 @@ module Lutaml
           result.item_order = element.order
 
           element.children.each_with_object(result) do |child, hash|
-            attr = klass.attribute_for_child(child.name, format) if klass&.<= Serialize
+            if klass&.<= Serialize
+              attr = klass.attribute_for_child(child.name,
+                                               format)
+            end
 
             value = if child.text?
                       child.text
@@ -136,7 +139,8 @@ module Lutaml
           rule = options[:rule]
 
           if rule.custom_methods[:to]
-            options[:mapper_class].new.send(rule.custom_methods[:to], element, xml.parent, xml)
+            options[:mapper_class].new.send(rule.custom_methods[:to], element,
+                                            xml.parent, xml)
             return
           end
 
@@ -203,7 +207,8 @@ module Lutaml
             end
 
             xml_mapping.attributes.each do |attribute_rule|
-              attribute_rule.serialize_attribute(element, prefixed_xml.parent, xml)
+              attribute_rule.serialize_attribute(element, prefixed_xml.parent,
+                                                 xml)
             end
 
             xml_mapping.elements.each do |element_rule|
@@ -223,11 +228,13 @@ module Lutaml
                 element,
                 element_rule.prefix,
                 value,
-                options.merge({ attribute: attribute_def, rule: element_rule, mapper_class: mapper_class }),
+                options.merge({ attribute: attribute_def, rule: element_rule,
+                                mapper_class: mapper_class }),
               )
             end
 
-            process_content_mapping(element, xml_mapping.content_mapping, prefixed_xml)
+            process_content_mapping(element, xml_mapping.content_mapping,
+                                    prefixed_xml)
 
             process_raw_mapping(element, xml_mapping.raw_mapping, prefixed_xml)
           end
@@ -318,7 +325,8 @@ module Lutaml
             next unless type
 
             if type <= Lutaml::Model::Serialize
-              attrs = attrs.merge(build_namespace_attributes(type, processed, { caller_rule: mapping_rule }))
+              attrs = attrs.merge(build_namespace_attributes(type, processed,
+                                                             { caller_rule: mapping_rule }))
             end
 
             if mapping_rule.namespace && mapping_rule.prefix && mapping_rule.name != "lang"
@@ -348,8 +356,10 @@ 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)
+            if render_element?(mapping_rule, element,
+                               mapping_rule.to_value_for(element))
+              hash[mapping_rule.prefixed_name] =
+                mapping_rule.to_value_for(element)
             end
           end
 

data/lib/lutaml/model/xml_mapping.rb

@@ -222,12 +222,15 @@ module Lutaml
 
       def deep_dup
         self.class.new.tap do |xml_mapping|
-          xml_mapping.root(@root_element.dup, mixed: @mixed_content, ordered: @ordered)
+          xml_mapping.root(@root_element.dup, mixed: @mixed_content,
+                                              ordered: @ordered)
           xml_mapping.namespace(@namespace_uri.dup, @namespace_prefix.dup)
 
-          xml_mapping.instance_variable_set(:@attributes, dup_mappings(@attributes))
+          xml_mapping.instance_variable_set(:@attributes,
+                                            dup_mappings(@attributes))
           xml_mapping.instance_variable_set(:@elements, dup_mappings(@elements))
-          xml_mapping.instance_variable_set(:@content_mapping, @content_mapping&.deep_dup)
+          xml_mapping.instance_variable_set(:@content_mapping,
+                                            @content_mapping&.deep_dup)
         end
       end
 

metadata

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