lutaml-model 0.3.27 → 0.3.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e00c3fab326d719d8341687a8411797d60ccaf54820380ba7a2dacead6a89792
-  data.tar.gz: e46c1dd3d50f6b2bea7da738d94ace488655205deb049170057490f6d1526bf8
+  metadata.gz: 7fbf76c4bb8fbe07fdaed6235a5e8edcd98dc17ace1d322d0e9a36c7c4a59aef
+  data.tar.gz: f63bf29850309ab1250e2713e62fd6ef624ad5c13a824dc6e7822dec77f75369
 SHA512:
-  metadata.gz: ab260d59203839c5fd9b1aa670501c1953c741fe75f0f7ab7261795c54cd19ed6de9807f9b8252c83ce9eee8cf2e6a9116087066e464ca1f35b8b46e29082351
-  data.tar.gz: c579a87612ce8e249edcca0c79f0ee2550d40af899e31ee2405ffdd48509e584df449c19bb3489a6871cdf4dfc08c4bc51f482422ea9a7d91f02d706d653cac6
+  metadata.gz: 58b261437656342dc5894e25dcde477f680e72b6eebd0ae6771a5d97f0212442ae5dab446d0e182f5a4a712516b8781a0849bdcb1fa2ee1fbc831ecf9dc33695
+  data.tar.gz: 0af5c64461b6e9f5ab6d67b18ebe81e19db49123b4241b201c786b1632b567290ab55288f7047e01e3c5938316d7e93b8aca511f6f4a3f3759f1d4575fe758ae

data/README.adoc

@@ -874,6 +874,7 @@ class Example < Lutaml::Model::Serializable
 end
 ----
 
+
 === XML
 
 ==== Setting root element name
@@ -1789,7 +1790,7 @@ https://www.w3.org/TR/xmlschema-1/#xsi_schemaLocation[W3C XML standard].
 Key-value data models like JSON, YAML, and TOML all share a similar structure
 where data is stored as key-value pairs.
 
-Lutaml::Model works with these formats in a similar way.
+`Lutaml::Model` works with these formats in a similar way.
 
 ==== Mapping
 
@@ -1799,12 +1800,85 @@ Syntax:
 
 [source,ruby]
 ----
-json | yaml | toml do
+json | yaml | toml | key_value do
   map 'key_value_model_attribute_name', to: :name_of_attribute
 end
 ----
 
-.Using the `map` method to define key-value mappings
+
+==== Unified mapping
+
+The `key_value` method is a streamlined way to map all attributes for
+serialization into key-value formats including JSON, YAML, and TOML.
+
+If there is no definite differentiation between the key value formats, the
+`key_value` method simplifies defining mappings and improves code readability.
+
+
+.Using the `map` method to define the same mappings across all key-value formats
+[example]
+====
+This example shows how to define a key-value data model with the `key_value`
+method which maps the same attributes across all key-value formats.
+
+[source,ruby]
+----
+class CeramicModel < Lutaml::Model::Serializable
+  attribute :color, :string
+  attribute :glaze, :string
+  attribute :description, :string
+
+  key_value do
+    map :color, to: color
+    map :glz, to: :glaze
+    map :desc, to: :description
+  end
+
+  # Equivalent to the JSON, YAML, and TOML mappings.
+  #
+  # json and yaml and toml do
+  #   map :id, to: color
+  #   map :name, to: :full_name
+  #   map :status, to: :current_status
+  # end
+end
+----
+
+[source,json]
+----
+{
+  "color": "Navy Blue",
+  "glz": "Clear",
+  "desc": "A ceramic with a navy blue color and clear glaze."
+}
+----
+
+[source,yaml]
+----
+color: Navy Blue
+glz: Clear
+desc: A ceramic with a navy blue color and clear glaze.
+----
+
+[source,ruby]
+----
+> CeramicModel.from_json(json)
+> #<CeramicModel:0x0000000104ac7240 @color="Navy Blue", @glaze="Clear", @description="A ceramic with a navy blue color and clear glaze.">
+> CeramicModel.new(color: "Navy Blue", glaze: "Clear", description: "A ceramic with a navy blue color and clear glaze.").to_json
+> #{"color"=>"Navy Blue", "glz"=>"Clear", "desc"=>"A ceramic with a navy blue color and clear glaze."}
+----
+====
+
+==== Specific format mappings
+
+Specific key value formats can be mapping independently of other formats, including:
+
+* `json` for the JSON format
+* `yaml` for the YAML format
+* `toml` for the TOML format
+
+
+.Using the `map` method to define key-value mappings per format
 [example]
 ====
 [source,ruby]

data/lib/lutaml/model/config.rb

@@ -9,6 +9,7 @@ module Lutaml
       attr_accessor :xml_adapter, :toml_adapter
 
       AVAILABLE_FORMATS = %i[xml json yaml toml].freeze
+      KEY_VALUE_FORMATS = AVAILABLE_FORMATS - %i[xml]
 
       def configure
         yield self

data/lib/lutaml/model/serialize.rb

@@ -151,6 +151,13 @@ module Lutaml
           end
         end
 
+        def key_value(&block)
+          Lutaml::Model::Config::KEY_VALUE_FORMATS.each do |format|
+            mappings[format] ||= KeyValueMapping.new
+            mappings[format].instance_eval(&block)
+          end
+        end
+
         def hash_representation(instance, format, options = {})
           only = options[:only]
           except = options[:except]

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.3.27"
+    VERSION = "0.3.28"
   end
 end

data/spec/lutaml/model/serializable_spec.rb

@@ -25,6 +25,18 @@ module SerializeableSpec
     end
   end
 
+  class KeyValueMapper < Lutaml::Model::Serializable
+    attribute :first_name, :string
+    attribute :last_name, :string
+    attribute :age, :integer
+
+    key_value do
+      map :first_name, to: :first_name
+      map :last_name, to: :last_name
+      map :age, to: :age
+    end
+  end
+
   ### XML root mapping
 
   class RecordDate < Lutaml::Model::Serializable
@@ -207,6 +219,22 @@ RSpec.describe Lutaml::Model::Serializable do
     end
   end
 
+  describe "#key_value" do
+    let(:model) { SerializeableSpec::KeyValueMapper }
+
+    Lutaml::Model::Config::KEY_VALUE_FORMATS.each do |format|
+      it "defines 3 mappings for #{format}" do
+        expect(model.mappings_for(format).mappings.count).to eq(3)
+      end
+
+      it "defines mappings correctly for #{format}" do
+        defined_mappings = model.mappings_for(format).mappings.map(&:name)
+
+        expect(defined_mappings).to eq(%i[first_name last_name age])
+      end
+    end
+  end
+
   describe "XML root name override" do
     it "uses root name defined at the component class" do
       record_date = SerializeableSpec::RecordDate.new(content: "2021-01-01")

metadata

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