lutaml-model 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57b531de09099b0f55b1891c2b0dfec1a04fa75229a40c5c6b974f3be92fcda
-  data.tar.gz: a893710f75fde8b5465360b95e6e772ba35711311a719ac35704a9a8ea7788ca
+  metadata.gz: 75da66a7985ef5c93b6c5f93a660046026a158b85a422cf924ce7a641f57d488
+  data.tar.gz: 5b3cbb99bd8c4398dec561c3885c2d996dd0491a0ba44d074549cc09c55cb59b
 SHA512:
-  metadata.gz: b9ef9798066d2ec69567a2cfb9277d0058b933b640df9c6c240c1010a626560c27cdd722d10a474deddf70560f902bf58d41e35d1e2d1a8aa0fe83a9451afb2a
-  data.tar.gz: 2c2bd13597f84afecd1aaf6fa4686db48048e371b014c55cb8c5993668eec38781e8b02ccd85a8ae5b68da8b3ea68056db87be7830128d35735c69f098711ff0
+  metadata.gz: '04728da10c80f08e47645646f4f06bbc796b074f8f1941594574f1d69fee96c32882b3db69d02b2f7878822b84423a46c81bb8a5ebb118d5b9c97533c0553e46'
+  data.tar.gz: 06cc0fcbb12ea5fc260eb25b3ecf3c5fc204738df760c5e33468b285007a4c0f0bd955e00ce1c128267c11f97d943f9a1f24b55c3a799ff3d730d0453c602bd8

data/README.adoc

@@ -13,8 +13,9 @@ objects to and from various formats such as JSON, XML, YAML, and TOML. It uses
 an adapter pattern to support multiple libraries for each format, providing
 flexibility and extensibility for your data modeling needs.
 
-NOTE: Lutaml::Model is designed to be mostly compatible with the data modeling
-API of https://www.shalerb.org[Shale], an impressive Ruby data modeller.
+NOTE: The Lutaml::Model modeling Ruby API is designed to be mostly compatible
+with the data modeling API of https://www.shalerb.org[Shale], a data modeller
+for Ruby.
 Lutaml::Model is meant to address advanced needs not currently addressed by
 Shale.
 
@@ -95,36 +96,39 @@ Studio (Model)
 .Modeling relationships of a LutaML Model to serialization models
 [source]
 ----
-    Core Model                  Serialization Model
-    ==========                  ===================
-        │                           (mapping)
-        │                               │
-        ▼                               ▼
-      Model                         XML Model
-        │                               │
-  ┌─────┴─────┐                  ┌──────┴──────┐
-  │           │                  │             │
-Models   Value Types ────┬──►  Models     Value Types
-  │           │          │       │             │
-  │           │          │       │             │
-  │    ┌──────┴──┐       │  ┌────┴────┐      ┌─┴─┐
-  │    │         │       │  │         │      │   │
-  │   String  Integer    │ Element  Value  xs:string
-  │   Date    Float      │ Attribute Type  xs:date
-  │   Time    Boolean    │                 xs:boolean
-  │                      │                 xs:anyURI
-  └──────┐               │
-         │               │         JSON Model
-    Contains             │              │
-    more Models          │       ┌──────┴──────┐
-    (recursive)          │       │             │
-                         └──►  Models     Value Types
-                                 │             │
-                                 │             │
-                            ┌────┴────┐      ┌─┴─┐
-                            │         │      │   │
-                           object  array  number string
-                           value          boolean null
+╔═══════════════════════╗                      ╔════════════════════════════╗
+║       Core Model      ║                      ║    Serialization Models    ║
+╚═══════════════════════╝                      ╚════════════════════════════╝
+
+╭┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╮                      ╭┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╮
+┆          Model        ┆                      ┆          XML Model         ┆
+┆            │          ┆   ┌────────────────┐ ┆              │             ┆
+┆   ┌────────┴──┐       ┆   │                │ ┆       ┌──────┴──────┐      ┆
+┆   │           │       ┆   │     Model      │ ┆       │             │      ┆
+┆ Models   Value Types  ┆──►│ Transformation │ ┆    Models      Value Types ┆
+┆   │           │       ┆   │       &        │ ┆       │             │      ┆
+┆   │           │       ┆   │ Mapping Rules  │ ┆       │             │      ┆
+┆   │    ┌──────┴──┐    ┆   │                │ ┆  ┌────┴────┐      ┌─┴─┐    ┆
+┆   │    │         │    ┆   │                │ ┆  │         │      │   │    ┆
+┆   │   String  Integer ┆   └────────────────┘ ┆ Element  Value  xs:string  ┆
+┆   │   Date    Float   ┆           │          ┆ Attribute Type  xs:date    ┆
+┆   │   Time    Boolean ┆           ├──────►   ┆                 xs:boolean ┆
+┆   │                   ┆           │          ┆                 xs:anyURI  ┆
+┆   └──────┐            ┆           │          ╰┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╯
+┆          │            ┆           │
+┆     Contains          ┆           │          ╭┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╮
+┆     more Models       ┆           │          ┆          JSON Model        ┆
+┆     (recursive)       ┆           │          ┆              │             ┆
+┆                       ┆           │          ┆       ┌──────┴──────┐      ┆
+╰┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╯           └───────►  ┆       │             │      ┆
+                                               ┆    Models      Value Types ┆
+                                               ┆       │             │      ┆
+                                               ┆       │             │      ┆
+                                               ┆  ┌────┴───┐     ┌───┴──┐   ┆
+                                               ┆  │        │     │      │   ┆
+                                               ┆ object array number string ┆
+                                               ┆ value        boolean null  ┆
+                                               ╰┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╯
 ----
 
 .Example of LutaML Model instance transformed into a serialization model and serialized to JSON
@@ -278,6 +282,7 @@ attribute :name_of_attribute, {symbol | string | class}
 | `:time`               | `Time`                   | `xs:dateTime`     | `string`  | `string`  | `"2024-01-01T12:00:00+00:00"`
 | `:decimal` (optional) | `BigDecimal`             | `xs:decimal`      | `number`  | `float`   | `123.45`
 | `:hash`               | `Hash`                   | complex element   | object    | map       | `{key: "value"}`
+| (nil value)           | `nil`                    | `xs:anyType`      | `null`    | `null`    | `null`
 // | `class`               | Custom class             | complex element   | object    | map       | `CustomObject`
 // | `collection: true`    | `Array` of type          | repeated elements | array     | sequence  | `[obj1, obj2]`
 // | `any`

data/lib/lutaml/model/mapping_rule.rb

@@ -34,6 +34,10 @@ module Lutaml
       alias render_default? render_default
       alias attribute? attribute
 
+      def render?(value)
+        render_nil? || (!value.nil? && !Utils.empty_collection?(value))
+      end
+
       def serialize_attribute(model, element, doc)
         if custom_methods[:to]
           model.send(custom_methods[:to], model, element, doc)

data/lib/lutaml/model/serialize.rb

@@ -271,15 +271,15 @@ module Lutaml
 
             attribute = attributes[name]
 
-            next hash.merge!(generate_hash_from_child_mappings(value, format, rule.root_mappings)) if rule.root_mapping?
+            next hash.merge!(generate_hash_from_child_mappings(attribute, value, format, rule.root_mappings)) if rule.root_mapping?
 
             value = if rule.child_mappings
-                      generate_hash_from_child_mappings(value, format, rule.child_mappings)
+                      generate_hash_from_child_mappings(attribute, value, format, rule.child_mappings)
                     else
                       attribute.serialize(value, format, options)
                     end
 
-            next if Utils.blank?(value) && !rule.render_nil
+            next unless rule.render?(value)
 
             rule_from_name = rule.multiple_mappings? ? rule.from.first.to_s : rule.from.to_s
             hash[rule_from_name] = value
@@ -346,7 +346,7 @@ module Lutaml
           end
         end
 
-        def generate_hash_from_child_mappings(value, format, child_mappings)
+        def generate_hash_from_child_mappings(attr, value, format, child_mappings)
           return value unless child_mappings
 
           hash = {}
@@ -365,7 +365,11 @@ module Lutaml
           value.each do |child_obj|
             map_key = nil
             map_value = {}
+            mapping_rules = attr.type.mappings_for(format)
+
             child_mappings.each do |attr_name, path|
+              mapping_rule = mapping_rules.find_by_to(attr_name)
+
               attr_value = child_obj.send(attr_name)
 
               attr_value = if attr_value.is_a?(Lutaml::Model::Serialize)
@@ -376,7 +380,7 @@ module Lutaml
                              attr_value
                            end
 
-              next if Utils.blank?(attr_value)
+              next unless mapping_rule&.render?(attr_value)
 
               if path == :key
                 map_key = attr_value

data/lib/lutaml/model/utils.rb

@@ -42,6 +42,13 @@ module Lutaml
           value.respond_to?(:empty?) ? value.empty? : value.nil?
         end
 
+        def empty_collection?(collection)
+          return false if collection.nil?
+          return false unless [Array, Hash].include?(collection.class)
+
+          collection.empty?
+        end
+
         def add_method_if_not_defined(klass, method_name, &block)
           unless klass.method_defined?(method_name)
             klass.class_eval do

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.5.2"
+    VERSION = "0.5.3"
   end
 end

data/spec/lutaml/model/render_nil_spec.rb

@@ -136,4 +136,33 @@ RSpec.describe RenderNil do
     expect(pottery.name).to eq("Unnamed Pottery")
     expect(pottery.glaze).to be_nil
   end
+
+  context "with empty string as values for attributes" do
+    let(:attributes) do
+      {
+        name: "",
+        clay_type: "",
+        glaze: "",
+        dimensions: [],
+        render_nil_nested: RenderNilNested.new,
+      }
+    end
+
+    it "does not tread empty string as nil" do
+      expected_yaml = <<~YAML
+        ---
+        name: ''
+        clay_type: ''
+        glaze: ''
+      YAML
+
+      generated_yaml = model.to_yaml.strip
+
+      # Removing empty spaces from the end of the line because of and issue in
+      # libyaml -> https://github.com/yaml/libyaml/issues/46
+      generated_yaml = generated_yaml.gsub(": \n", ":\n")
+
+      expect(generated_yaml).to eq(expected_yaml.strip)
+    end
+  end
 end

metadata

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