lutaml-model 0.3.14 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b36d07a850d4736c0634735a198f05dd34c49b906cd1265b3dd49266931eb22
-  data.tar.gz: cefd0559ad4010ecd2ab0a547ab87493b4958a480f6cb19ab317c248836b8f75
+  metadata.gz: b9687a8a307de8226b41a87abda56626627eefe47665628c0e9112b97f27385a
+  data.tar.gz: e819f531048e629d4943ea7b613815a568990f372ef2da93162d0d1b4d8395cd
 SHA512:
-  metadata.gz: 83fac7632d0eec4f5bd4339132b36d267877932cf34839eac6dbdefd0cd0e551988b73b3cd379b856af0df351e42694c157342efd8baba67e283e71d34b88171
-  data.tar.gz: 6befe6bfce13fb6175a04f8e0ac81794304d3c56c51feea343334c501346cba517db1f89ab3387ea3300e546d160d24af264048e9762c85debc4063300d57025
+  metadata.gz: f47d1336093db1eb45c5225913a9c63d66681de77d5803a21702baab0ca8e571e882a2d8f6f6dcf7b9180c897c9ae8bfd4b2db6532e9691487d104696657457e
+  data.tar.gz: 9ec8b8d841606d202acdcca81464761cc0f75e9ae5b35d2c3b8dd01c6e8a122642a348f41de2852b09386d3748eb61b1b2547df8d1ccb146a7d36e5a8ac46257

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-10-23 12:15:48 UTC using RuboCop version 1.66.1.
+# on 2024-10-28 08:29:46 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: 139
+# Offense count: 148
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -69,10 +69,10 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Max: 51
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
-  Max: 12
+  Max: 13
 
 # Offense count: 22
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
@@ -85,7 +85,7 @@ Metrics/PerceivedComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 8
+# Offense count: 9
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -125,7 +125,7 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 119
+# Offense count: 125
 RSpec/MultipleExpectations:
   Max: 14
 
@@ -134,6 +134,11 @@ RSpec/MultipleExpectations:
 RSpec/MultipleMemoizedHelpers:
   Max: 9
 
+# Offense count: 4
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
+
 # Offense count: 7
 RSpec/PendingWithoutReason:
   Exclude:
@@ -153,13 +158,14 @@ RSpec/RepeatedExampleGroupDescription:
   Exclude:
     - 'spec/lutaml/model/collection_spec.rb'
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
 # Include: **/*_spec.rb
 RSpec/SpecFilePathFormat:
   Exclude:
     - '**/spec/routing/**/*'
     - 'spec/lutaml/model/collection_spec.rb'
+    - 'spec/lutaml/model/defaults_spec.rb'
     - 'spec/lutaml/model/type/decimal_spec.rb'
 
 # Offense count: 1

data/README.adoc

@@ -390,7 +390,7 @@ acceptance of the newly updated component.
 ====
 
 
-=== Attribute value default
+=== Attribute value default and rendering defaults
 
 Specify default values for attributes using the `default` option.
 The `default` option can be set to a value or a lambda that returns a value.
@@ -423,6 +423,80 @@ end
 ----
 ====
 
+The "default behavior" (pun intended) is to not render a default value if
+the current value is the same as the default value.
+
+In certain cases, it is necessary to render the default value even if the
+current value is the same as the default value. This can be achieved by setting
+the `render_default` option to `true`.
+
+Syntax:
+
+[source,ruby]
+----
+attribute :name_of_attribute, Type, default: -> { value }, render_default: true
+----
+
+.Using the `render_default` option to force encoding the default value
+[example]
+====
+[source,ruby]
+----
+class Glaze < Lutaml::Model::Serializable
+  attribute :color, :string, default: -> { 'Clear' }
+  attribute :opacity, :string, default: -> { 'Opaque' }
+  attribute :temperature, :integer, default: -> { 1050 }
+  attribute :firing_time, :integer, default: -> { 60 }
+
+  xml do
+    root "glaze"
+    map_element 'color', to: :color
+    map_element 'opacity', to: :opacity, render_default: true
+    map_attribute 'temperature', to: :temperature
+    map_attribute 'firingTime', to: :firing_time, render_default: true
+  end
+
+  json do
+    map 'color', to: :color
+    map 'opacity', to: :opacity, render_default: true
+    map 'temperature', to: :temperature
+    map 'firingTime', to: :firing_time, render_default: true
+  end
+end
+----
+
+.Attributes with `render_default: true` are rendered when the value is identical to the default
+[example]
+====
+[source,ruby]
+----
+> glaze_new = Glaze.new
+> puts glaze_new.to_xml
+# <glaze firingTime="60">
+#   <opacity>Opaque</opacity>
+# </glaze>
+> puts glaze_new.to_json
+# {"firingTime":60,"opacity":"Opaque"}
+----
+====
+
+.Attributes with `render_default: true` with non-default values are rendered
+[example]
+====
+[source,ruby]
+----
+> glaze = Glaze.new(color: 'Celadon', opacity: 'Semitransparent', temperature: 1300, firing_time: 90)
+> puts glaze.to_xml
+# <glaze color="Celadon" temperature="1300" firingTime="90">
+#   <opacity>Semitransparent</opacity>
+# </glaze>
+> puts glaze.to_json
+# {"color":"Celadon","temperature":1300,"firingTime":90,"opacity":"Semitransparent"}
+----
+====
+
+
+
 === Attribute as raw string
 
 An attribute can be set to read the value as raw string for XML, by using the `raw: true` option.
@@ -668,8 +742,10 @@ end
 > #<example value="12"></example>
 ----
 
-The map_attribute method does not inherit the root element's namespace. If you need to specify a namespace for an attribute,
-you must explicitly declare the namespace and prefix in the map_attribute method.
+The `map_attribute` method does not inherit the root element's namespace.
+To specify a namespace for an attribute, please explicitly declare the
+*namespace* and *prefix* in the `map_attribute` method.
+
 [example]
 ====
 The following class will parse the XML snippet below:
@@ -1081,7 +1157,7 @@ end
 ----
 ====
 
-TODO: How to create mixed content from `#new`?
+// TODO: How to create mixed content from `#new`?
 
 [[xml-schema-location]]
 ==== Automatic support of `xsi:schemaLocation`
@@ -2020,7 +2096,9 @@ Lutaml::Model::Config.configure do |config|
 end
 ----
 
-NOTE: By default `yaml_adapter_type` and `json_adapter_type` are set to `:standard_yaml` and `:standard_json` respectively.
+NOTE: By default `yaml_adapter_type` and `json_adapter_type` are set to
+`:standard_yaml` and `:standard_json` respectively.
+
 
 === XML
 

data/lib/lutaml/model/attribute.rb

@@ -3,10 +3,20 @@ module Lutaml
     class Attribute
       attr_reader :name, :type, :options
 
+      ALLOWED_OPTIONS = %i[
+        raw
+        default
+        delegate
+        collection
+        values
+      ].freeze
+
       def initialize(name, type, options = {})
         @name = name
         @type = cast_type(type)
         @options = options
+        validate_options!
+
         @raw = !!options[:raw]
 
         if collection?
@@ -66,10 +76,6 @@ module Lutaml
         cast_value(value)
       end
 
-      def render_nil?
-        options.fetch(:render_nil, false)
-      end
-
       def enum_values
         @options.key?(:values) ? @options[:values] : []
       end
@@ -203,6 +209,14 @@ module Lutaml
           Lutaml::Model::Type.cast(value, type)
         end
       end
+
+      private
+
+      def validate_options!
+        if (options = @options.keys - ALLOWED_OPTIONS).any?
+          raise StandardError, "Invalid options given for `#{name}` #{options}"
+        end
+      end
     end
   end
 end

data/lib/lutaml/model/key_value_mapping.rb

@@ -13,6 +13,7 @@ module Lutaml
         name,
         to: nil,
         render_nil: false,
+        render_default: false,
         with: {},
         delegate: nil,
         child_mappings: nil
@@ -23,6 +24,7 @@ module Lutaml
           name,
           to: to,
           render_nil: render_nil,
+          render_default: render_default,
           with: with,
           delegate: delegate,
           child_mappings: child_mappings,

data/lib/lutaml/model/key_value_mapping_rule.rb

@@ -9,6 +9,7 @@ module Lutaml
         name,
         to:,
         render_nil: false,
+        render_default: false,
         with: {},
         delegate: nil,
         child_mappings: nil
@@ -17,6 +18,7 @@ module Lutaml
           name,
           to: to,
           render_nil: render_nil,
+          render_default: render_default,
           with: with,
           delegate: delegate,
         )

data/lib/lutaml/model/mapping_rule.rb

@@ -4,6 +4,8 @@ module Lutaml
       attr_reader :name,
                   :to,
                   :render_nil,
+                  :render_default,
+                  :attribute,
                   :custom_methods,
                   :delegate
 
@@ -11,6 +13,7 @@ module Lutaml
         name,
         to:,
         render_nil: false,
+        render_default: false,
         with: {},
         attribute: false,
         delegate: nil
@@ -18,6 +21,7 @@ module Lutaml
         @name = name
         @to = to
         @render_nil = render_nil
+        @render_default = render_default
         @custom_methods = with
         @attribute = attribute
         @delegate = delegate
@@ -25,6 +29,8 @@ module Lutaml
 
       alias from name
       alias render_nil? render_nil
+      alias render_default? render_default
+      alias attribute? attribute
 
       def serialize_attribute(model, element, doc)
         if custom_methods[:to]

data/lib/lutaml/model/serialize.rb

@@ -40,35 +40,30 @@ module Lutaml
         def model(klass = nil)
           if klass
             @model = klass
-            add_order_handling_methods_to_model(klass)
+            add_custom_handling_methods_to_model(klass)
           else
             @model
           end
         end
 
-        def add_order_handling_methods_to_model(klass)
-          Utils.add_method_if_not_defined(klass, :ordered=) do |ordered|
-            @ordered = ordered
-          end
-
-          Utils.add_method_if_not_defined(klass, :ordered?) do
-            !!@ordered
-          end
-
-          Utils.add_method_if_not_defined(klass, :mixed=) do |mixed|
-            @mixed = mixed
-          end
+        def add_custom_handling_methods_to_model(klass)
+          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_method_if_not_defined(klass, :mixed?) do
-            !!@mixed
+          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, :element_order=) do |order|
-            @element_order = order
+          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, :element_order) do
-            @element_order
+          Utils.add_method_if_not_defined(klass, :using_default?) do |attribute_name|
+            @using_default ||= {}
+            !!@using_default[attribute_name]
           end
         end
 
@@ -86,6 +81,7 @@ module Lutaml
           end
 
           define_method(:"#{name}=") do |value|
+            value_set_for(name)
             instance_variable_set(:"@#{name}", attr.cast_value(value))
           end
         end
@@ -159,6 +155,7 @@ module Lutaml
           mappings.each_with_object({}) do |rule, hash|
             name = rule.to
             next if except&.include?(name) || (only && !only.include?(name))
+            next if !rule.render_default? && instance.using_default?(rule.to)
 
             next handle_delegate(instance, rule, hash, format) if rule.delegate
 
@@ -223,11 +220,10 @@ module Lutaml
           klass = format == :xml ? XmlMapping : KeyValueMapping
 
           klass.new.tap do |mapping|
-            attributes&.each do |name, attr|
+            attributes&.each_key do |name|
               mapping.map_element(
                 name.to_s,
                 to: name,
-                render_nil: attr.render_nil?,
               )
             end
 
@@ -304,33 +300,7 @@ module Lutaml
           return instance if Utils.blank?(doc)
           return apply_xml_mapping(doc, instance, options) if format == :xml
 
-          mappings = mappings_for(format).mappings
-          mappings.each do |rule|
-            raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
-
-            attr = attribute_for_rule(rule)
-
-            value = if doc.key?(rule.name) || doc.key?(rule.name.to_sym)
-                      doc[rule.name] || doc[rule.name.to_sym]
-                    else
-                      attr.default
-                    end
-
-            if rule.custom_methods[:from]
-              if Utils.present?(value)
-                value = new.send(rule.custom_methods[:from], instance, value)
-              end
-
-              next
-            end
-
-            value = apply_child_mappings(value, rule.child_mappings)
-            value = attr.cast(value, format)
-
-            rule.deserialize(instance, value, attributes, self)
-          end
-
-          instance
+          apply_hash_mapping(doc, instance, format, options)
         end
 
         def apply_xml_mapping(doc, instance, options = {})
@@ -357,6 +327,8 @@ module Lutaml
             )
           end
 
+          defaults_used = []
+
           mappings.each do |rule|
             raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
 
@@ -365,6 +337,7 @@ module Lutaml
                     elsif doc.key_exist?(rule.namespaced_name)
                       doc.fetch(rule.namespaced_name)
                     else
+                      defaults_used << rule.to
                       rule.to_value_for(instance)
                     end
 
@@ -372,6 +345,40 @@ module Lutaml
             rule.deserialize(instance, value, attributes, self)
           end
 
+          defaults_used.each do |attribute_name|
+            instance.using_default_for(attribute_name)
+          end
+
+          instance
+        end
+
+        def apply_hash_mapping(doc, instance, format, _options = {})
+          mappings = mappings_for(format).mappings
+          mappings.each do |rule|
+            raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
+
+            attr = attribute_for_rule(rule)
+
+            value = if doc.key?(rule.name) || doc.key?(rule.name.to_sym)
+                      doc[rule.name] || doc[rule.name.to_sym]
+                    else
+                      attr.default
+                    end
+
+            if rule.custom_methods[:from]
+              if Utils.present?(value)
+                value = new.send(rule.custom_methods[:from], instance, value)
+              end
+
+              next
+            end
+
+            value = apply_child_mappings(value, rule.child_mappings)
+            value = attr.cast(value, format)
+
+            rule.deserialize(instance, value, attributes, self)
+          end
+
           instance
         end
 
@@ -433,6 +440,7 @@ module Lutaml
 
       def initialize(attrs = {})
         @validate_on_set = attrs.delete(:validate_on_set) || false
+        @using_default ||= {}
 
         return unless self.class.attributes
 
@@ -449,6 +457,7 @@ module Lutaml
           value = if attrs.key?(name) || attrs.key?(name.to_s)
                     self.class.attr_value(attrs, name, attr)
                   else
+                    using_default_for(name)
                     attr.default
                   end
 
@@ -461,6 +470,18 @@ module Lutaml
         end
       end
 
+      def using_default_for(attribute_name)
+        @using_default[attribute_name] = true
+      end
+
+      def value_set_for(attribute_name)
+        @using_default[attribute_name] = false
+      end
+
+      def using_default?(attribute_name)
+        @using_default[attribute_name]
+      end
+
       def method_missing(method_name, *args)
         if method_name.to_s.end_with?("=") && self.class.attributes.key?(method_name.to_s.chomp("=").to_sym)
           define_singleton_method(method_name) do |value|

data/lib/lutaml/model/utils.rb

@@ -50,6 +50,34 @@ module Lutaml
           end
         end
 
+        def add_accessor_if_not_defined(klass, attribute)
+          add_getter_if_not_defined(klass, attribute)
+          add_setter_if_not_defined(klass, attribute)
+        end
+
+        def add_boolean_accessor_if_not_defined(klass, attribute)
+          add_boolean_getter_if_not_defined(klass, attribute)
+          add_setter_if_not_defined(klass, attribute)
+        end
+
+        def add_getter_if_not_defined(klass, attribute)
+          add_method_if_not_defined(klass, attribute) do
+            instance_variable_get(:"@__#{attribute}")
+          end
+        end
+
+        def add_boolean_getter_if_not_defined(klass, attribute)
+          add_method_if_not_defined(klass, "#{attribute}?") do
+            !!instance_variable_get(:"@__#{attribute}")
+          end
+        end
+
+        def add_setter_if_not_defined(klass, attribute)
+          add_method_if_not_defined(klass, "#{attribute}=") do |value|
+            instance_variable_set(:"@__#{attribute}", value)
+          end
+        end
+
         def deep_dup(hash)
           return hash if hash.nil?
 

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.14"
+    VERSION = "0.3.16"
   end
 end

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

@@ -143,6 +143,8 @@ module Lutaml
             return
           end
 
+          return if !render_element?(rule, element, value)
+
           if value && (attribute&.type&.<= Lutaml::Model::Serialize)
             handle_nested_elements(
               xml,
@@ -254,6 +256,20 @@ module Lutaml
           rule.nil? || !rule.namespace_set? || !rule.namespace.nil?
         end
 
+        def render_element?(rule, element, value)
+          render_default?(rule, element) && render_value?(rule, value)
+        end
+
+        def render_value?(rule, value)
+          rule.attribute? || rule.render_nil? || !value.nil?
+        end
+
+        def render_default?(rule, element)
+          !element.respond_to?(:using_default?) ||
+            rule.render_default? ||
+            !element.using_default?(rule.to)
+        end
+
         def build_namespace_attributes(klass, processed = {}, options = {})
           xml_mappings = klass.mappings_for(:xml)
           attributes = klass.attributes
@@ -315,7 +331,9 @@ module Lutaml
               hash["xmlns:#{mapping_rule.prefix}"] = mapping_rule.namespace
             end
 
-            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
 
           xml_mapping.elements.each_with_object(attrs) do |mapping_rule, hash|

data/lib/lutaml/model/xml_mapping.rb

@@ -43,6 +43,7 @@ module Lutaml
         name,
         to: nil,
         render_nil: false,
+        render_default: false,
         with: {},
         delegate: nil,
         namespace: (namespace_set = false
@@ -56,6 +57,7 @@ module Lutaml
           name,
           to: to,
           render_nil: render_nil,
+          render_default: render_default,
           with: with,
           delegate: delegate,
           namespace: namespace,
@@ -71,6 +73,7 @@ module Lutaml
         name,
         to: nil,
         render_nil: false,
+        render_default: false,
         with: {},
         delegate: nil,
         namespace: (namespace_set = false
@@ -84,6 +87,7 @@ module Lutaml
           name,
           to: to,
           render_nil: render_nil,
+          render_default: render_default,
           with: with,
           delegate: delegate,
           namespace: namespace,
@@ -101,6 +105,7 @@ module Lutaml
       def map_content(
         to: nil,
         render_nil: false,
+        render_default: false,
         with: {},
         delegate: nil,
         mixed: false
@@ -111,6 +116,7 @@ module Lutaml
           nil,
           to: to,
           render_nil: render_nil,
+          render_default: render_default,
           with: with,
           delegate: delegate,
           mixed_content: mixed,

data/lib/lutaml/model/xml_mapping_rule.rb

@@ -9,6 +9,7 @@ module Lutaml
         name,
         to:,
         render_nil: false,
+        render_default: false,
         with: {},
         delegate: nil,
         namespace: nil,
@@ -23,6 +24,7 @@ module Lutaml
           name,
           to: to,
           render_nil: render_nil,
+          render_default: render_default,
           with: with,
           delegate: delegate,
           attribute: attribute,

metadata

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