lutaml-model 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8362f4af3671083805d20014ef7e2422358aac08f1c15036a283dbedb91225ca
-  data.tar.gz: 661838fcd61e972cd1827a1b4889b3d2073e7a8db16a4fce371dcbf09fb79b96
+  metadata.gz: 30487a24277470ff7b3d12193e46262b0fc1cac85461224ed98749c8b6de5104
+  data.tar.gz: a161a8e5f83a10ec5db5b77a0d5a0abe72b629d0900a4ab040414c2a02c22725
 SHA512:
-  metadata.gz: 31757feb85022ff8472b8e178ff433a84e2dcbd7a00b6cc2055f3f4d860b4470201c2ee6c39d2a2b96cc86d96ec3654affd7078bb2cad595345afa50fec9826d
-  data.tar.gz: ff6f2048f11d46a9e4df1ec872bca13e5ebcbbc098aa35689840e3601d18337e2e7a85afd48f8a67b1b39482782258cdc1494f13eb1cd67eac8ac37cc2f5809d
+  metadata.gz: 2a805f81f93bc0dcb983d83e7f7fc870989f84fb25434de7edee18269c1b96b8572516132e17e3db2e188075e985cb8219ec84257fd380c7abfe4b65b32116af
+  data.tar.gz: 0243f89d6fb6c5466e29500e810a077096e260b51d53a8a23db7918c7b2d57dc30a9757dd00814a2c497dd552e39bd17e92729c509670dde555a0b508a77013b

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-08-23 04:30:59 UTC using RuboCop version 1.65.1.
+# on 2024-08-27 06:48:03 UTC using RuboCop version 1.65.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
@@ -14,76 +14,7 @@ Gemspec/RequireMFA:
   Exclude:
     - 'lutaml-model.gemspec'
 
-# Offense count: 28
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: with_first_argument, with_fixed_indentation
-Layout/ArgumentAlignment:
-  Exclude:
-    - 'lib/lutaml/model/serialize.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/serializable_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: IndentationWidth.
-Layout/AssignmentIndentation:
-  Exclude:
-    - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleAlignWith.
-# SupportedStylesAlignWith: either, start_of_block, start_of_line
-Layout/BlockAlignment:
-  Exclude:
-    - 'lib/lutaml/model/xml_adapter/xml_document.rb'
-    - 'spec/lutaml/model/serializable_spec.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-Layout/BlockEndNewline:
-  Exclude:
-    - 'lib/lutaml/model/xml_adapter/xml_document.rb'
-    - 'spec/lutaml/model/serializable_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/lutaml/model/serialize.rb'
-
-# Offense count: 16
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'lib/lutaml/model/serialize.rb'
-    - 'lib/lutaml/model/xml_adapter/xml_document.rb'
-    - 'spec/lutaml/model/serializable_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: normal, indented_internal_methods
-Layout/IndentationConsistency:
-  Exclude:
-    - 'lutaml-model.gemspec'
-
-# Offense count: 12
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/lutaml/model/xml_adapter/xml_document.rb'
-    - 'spec/lutaml/model/serializable_spec.rb'
-
-# Offense count: 83
+# Offense count: 57
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -103,17 +34,6 @@ Layout/LineLength:
     - 'spec/lutaml/model/schema/json_schema_spec.rb'
     - 'spec/lutaml/model/serializable_spec.rb'
 
-# Offense count: 24
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/lutaml/model/serialize.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/serializable_spec.rb'
-
 # Offense count: 4
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
@@ -141,12 +61,13 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 29
+  Max: 43
 
-# Offense count: 20
+# Offense count: 22
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
+    - 'lib/lutaml/model/attribute.rb'
     - 'lib/lutaml/model/comparable_model.rb'
     - 'lib/lutaml/model/serialize.rb'
     - 'lib/lutaml/model/type.rb'
@@ -154,20 +75,21 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 37
+# Offense count: 36
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 45
+  Max: 43
 
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 16
+# Offense count: 18
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
+    - 'lib/lutaml/model/attribute.rb'
     - 'lib/lutaml/model/comparable_model.rb'
     - 'lib/lutaml/model/serialize.rb'
     - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
@@ -239,35 +161,9 @@ Security/CompoundHash:
   Exclude:
     - 'lib/lutaml/model/comparable_model.rb'
 
-# Offense count: 10
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# AllowedMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'lib/lutaml/model/xml_adapter/xml_document.rb'
-    - 'spec/lutaml/model/serializable_spec.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Style/MultilineIfModifier:
-  Exclude:
-    - 'lib/lutaml/model/serialize.rb'
-
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
 Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/lutaml/model/comparable_model.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'lutaml-model.gemspec'

data/lib/lutaml/model/attribute.rb

@@ -61,7 +61,7 @@ module Lutaml
           value.map do |v|
             cast(v, format, instance: instance)
           end
-        elsif type <= Serialize
+        elsif type <= Serialize && value.is_a?(Hash)
           type.apply_mappings(value, format, options)
         else
           Lutaml::Model::Type.cast(value, type)

data/lib/lutaml/model/serialize.rb

@@ -84,28 +84,47 @@ module Lutaml
 
           define_method(:"from_#{format}") do |data|
             adapter = Lutaml::Model::Config.send(:"#{format}_adapter")
-            doc = adapter.parse(data)
 
-            apply_mappings(doc.to_h, format)
+            doc = adapter.parse(data)
+            public_send(:"of_#{format}", doc.to_h)
           end
 
-          define_method(:"to_#{format}") do |instance|
-            unless instance.is_a?(model)
-              msg = "argument is a '#{instance.class}' but should be a '#{model}'"
-              raise Lutaml::Model::IncorrectModelError, msg
+          define_method(:"of_#{format}") do |hash|
+            if hash.is_a?(Array)
+              return hash.map do |item|
+                apply_mappings(item, format)
+              end
             end
 
+            apply_mappings(hash, format)
+          end
+
+          define_method(:"to_#{format}") do |instance|
+            value = public_send(:"as_#{format}", instance)
             adapter = Lutaml::Model::Config.public_send(:"#{format}_adapter")
 
             if format == :xml
               xml_options = { mapper_class: self }
-
-              adapter.new(instance).public_send(:"to_#{format}", xml_options)
+              adapter.new(value).public_send(:"to_#{format}", xml_options)
             else
-              hash = hash_representation(instance, format)
-              adapter.new(hash).public_send(:"to_#{format}")
+              adapter.new(value).public_send(:"to_#{format}")
             end
           end
+
+          define_method(:"as_#{format}") do |instance|
+            if instance.is_a?(Array)
+              return instance.map { |item| public_send(:"as_#{format}", item) }
+            end
+
+            unless instance.is_a?(model)
+              msg = "argument is a '#{instance.class}' but should be a '#{model}'"
+              raise Lutaml::Model::IncorrectModelError, msg
+            end
+
+            return instance if format == :xml
+
+            hash_representation(instance, format)
+          end
         end
 
         def hash_representation(instance, format, options = {})
@@ -120,8 +139,7 @@ module Lutaml
             next handle_delegate(instance, rule, hash, format) if rule.delegate
 
             if rule.custom_methods[:to]
-              next instance.send(rule.custom_methods[:to], instance,
-                                 hash)
+              next instance.send(rule.custom_methods[:to], instance, hash)
             end
 
             value = instance.send(name)
@@ -238,6 +256,7 @@ module Lutaml
 
         def apply_mappings(doc, format, options = {})
           instance = options[:instance] || model.new
+          return instance if !doc || doc.empty?
           return apply_xml_mapping(doc, instance, options) if format == :xml
 
           mappings = mappings_for(format).mappings
@@ -257,7 +276,7 @@ module Lutaml
                     end
 
             if rule.custom_methods[:from]
-              value = new.send(rule.custom_methods[:from], instance, value)
+              value = new.send(rule.custom_methods[:from], instance, value) if value && !value.empty?
               next
             end
 
@@ -289,7 +308,7 @@ module Lutaml
                   "missing for #{self} in #{options[:caller_class]}"
           end
 
-          if instance.respond_to?(:ordered=)
+          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]
           end
@@ -299,12 +318,15 @@ module Lutaml
             raise "Attribute '#{rule.to}' not found in #{self}" unless attr
 
             is_content_mapping = rule.name.nil?
+
             value = if is_content_mapping
                       doc["text"]
                     else
                       doc[rule.name.to_s] || doc[rule.name.to_sym]
                     end
 
+            value = [value].compact if attr.collection? && !value.is_a?(Array)
+
             if value.is_a?(Array)
               value = value.map do |v|
                 v.is_a?(Hash) && !(attr.type <= Serialize) ? v["text"] : v

data/lib/lutaml/model/type.rb

@@ -22,11 +22,13 @@ module Lutaml
                      class #{t}                        # class Integer
             def self.cast(value)            #   def self.cast(value)
               return if value.nil?          #     return if value.nil?
+                                            #
               Type.cast(value, #{t})        #     Type.cast(value, Integer)
             end                             #   end
 
             def self.serialize(value)       #   def self.serialize(value)
               return if value.nil?          #     return if value.nil?
+                                            #
               Type.serialize(value, #{t})   #     Type.serialize(value, Integer)
             end                             #   end
           end                               # end

data/lib/lutaml/model/version.rb

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

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

@@ -72,17 +72,18 @@ module Lutaml
                 text = text[curr_index] if text.is_a?(Array)
 
                 prefixed_xml.text text
-              elsif attribute_def.collection?
+              elsif !value.nil? || element_rule.render_nil?
+                value = value[curr_index] if attribute_def.collection?
+
                 add_to_xml(
                   xml,
                   element_rule.prefix,
-                  value[curr_index],
-                  attribute_def,
-                  element_rule,
+                  value,
+                  options.merge(
+                    attribute: attribute_def,
+                    rule: element_rule,
+                  ),
                 )
-              elsif !value.nil? || element_rule.render_nil?
-                add_to_xml(xml, element_rule.prefix, value, attribute_def,
-                           element_rule)
               end
             end
           end
@@ -158,7 +159,7 @@ module Lutaml
           end
         end
 
-        def build_attributes(node)
+        def build_attributes(node, _options = {})
           attrs = node.attributes.transform_values(&:value)
 
           attrs.merge(build_namespace_attributes(node))

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

@@ -56,11 +56,18 @@ module Lutaml
                 text = text[curr_index] if text.is_a?(Array)
 
                 el.add_text(el, text)
-              elsif attribute_def.collection?
-                add_to_xml(el, nil, value[curr_index], attribute_def,
-                           element_rule)
               elsif !value.nil? || element_rule.render_nil?
-                add_to_xml(el, nil, value, attribute_def, element_rule)
+                value = value[curr_index] if attribute_def.collection?
+
+                add_to_xml(
+                  el,
+                  nil,
+                  value,
+                  options.merge(
+                    attribute: attribute_def,
+                    rule: element_rule,
+                  ),
+                )
               end
             end
           end

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

@@ -42,21 +42,24 @@ module Lutaml
           @root.order
         end
 
-        def handle_nested_elements(builder, value, rule: nil, attribute: nil)
-          options = build_options_for_nested_elements(attribute, rule)
+        def handle_nested_elements(builder, value, options = {})
+          element_options = build_options_for_nested_elements(options)
 
           case value
           when Array
-            value.each { |val| build_element(builder, val, options) }
+            value.each { |val| build_element(builder, val, element_options) }
           else
-            build_element(builder, value, options)
+            build_element(builder, value, element_options)
           end
         end
 
-        def build_options_for_nested_elements(attribute, rule)
+        def build_options_for_nested_elements(options = {})
+          attribute = options.delete(:attribute)
+          rule = options.delete(:rule)
+
           return {} unless rule
 
-          options = {}
+          # options = {}
 
           options[:namespace_prefix] = rule.prefix if rule&.namespace_set?
           options[:mixed_content] = rule.mixed_content
@@ -97,7 +100,18 @@ module Lutaml
           end
         end
 
-        def add_to_xml(xml, prefix, value, attribute, rule)
+        def add_to_xml(xml, prefix, value, options = {})
+          if value.is_a?(Array)
+            value.each do |item|
+              add_to_xml(xml, prefix, item, options)
+            end
+
+            return
+          end
+
+          attribute = options[:attribute]
+          rule = options[:rule]
+
           if rule.custom_methods[:to]
             @root.send(rule.custom_methods[:to], @root, xml.parent, xml)
             return
@@ -107,8 +121,7 @@ module Lutaml
             handle_nested_elements(
               xml,
               value,
-              rule: rule,
-              attribute: attribute,
+              options.merge({ rule: rule, attribute: attribute }),
             )
           else
             xml.create_and_add_element(rule.name, prefix: prefix) do
@@ -136,7 +149,7 @@ module Lutaml
 
           attributes = options[:xml_attributes] ||= {}
           attributes = build_attributes(element,
-                                        xml_mapping).merge(attributes)&.compact
+                                        xml_mapping, options).merge(attributes)&.compact
 
           prefix = if options.key?(:namespace_prefix)
                      options[:namespace_prefix]
@@ -156,21 +169,19 @@ module Lutaml
             xml_mapping.elements.each do |element_rule|
               attribute_def = attribute_definition_for(element, element_rule,
                                                        mapper_class: mapper_class)
+
               value = attribute_value_for(element, element_rule)
 
               next if value.nil? && !element_rule.render_nil?
 
-              if attribute_def.collection?
-                value = [value] unless value.is_a?(Array)
+              value = [value] if attribute_def.collection? && !value.is_a?(Array)
 
-                value.each do |v|
-                  add_to_xml(xml, element_rule.prefix, v, attribute_def,
-                             element_rule)
-                end
-              elsif !value.nil? || element_rule.render_nil?
-                add_to_xml(xml, element_rule.prefix, value, attribute_def,
-                           element_rule)
-              end
+              add_to_xml(
+                xml,
+                element_rule.prefix,
+                value,
+                options.merge({ attribute: attribute_def, rule: element_rule }),
+              )
             end
 
             if (content_rule = xml_mapping.content_mapping)
@@ -231,10 +242,12 @@ module Lutaml
           attrs
         end
 
-        def build_attributes(element, xml_mapping)
+        def build_attributes(element, xml_mapping, options = {})
           attrs = namespace_attributes(xml_mapping)
 
           xml_mapping.attributes.each_with_object(attrs) do |mapping_rule, hash|
+            next if options[:except]&.include?(mapping_rule.to)
+
             if mapping_rule.namespace
               hash["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end
@@ -243,6 +256,8 @@ module Lutaml
           end
 
           xml_mapping.elements.each_with_object(attrs) do |mapping_rule, hash|
+            next if options[:except]&.include?(mapping_rule.to)
+
             if mapping_rule.namespace
               hash["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-model
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor