lutaml-model 0.3.27 → 0.3.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e00c3fab326d719d8341687a8411797d60ccaf54820380ba7a2dacead6a89792
-  data.tar.gz: e46c1dd3d50f6b2bea7da738d94ace488655205deb049170057490f6d1526bf8
+  metadata.gz: fba70c8a3fca206b3109603109812019773027580c47b2e3615d873df6e0ce2d
+  data.tar.gz: 21313fbfb52c29c620eb1020672d337689eed963c25fe56c20baeef139e569b5
 SHA512:
-  metadata.gz: ab260d59203839c5fd9b1aa670501c1953c741fe75f0f7ab7261795c54cd19ed6de9807f9b8252c83ce9eee8cf2e6a9116087066e464ca1f35b8b46e29082351
-  data.tar.gz: c579a87612ce8e249edcca0c79f0ee2550d40af899e31ee2405ffdd48509e584df449c19bb3489a6871cdf4dfc08c4bc51f482422ea9a7d91f02d706d653cac6
+  metadata.gz: 274739542b8473ae58b4fc6b78e1152aaef604a55f3c9db0ec5678743573d683b4afdd2429d97d6a24c03fdb2c14a72904bf4e057f480e6bafc635a21fde085a
+  data.tar.gz: b1a7ad49313463676b3afe8732f94ed8ab37f79935f33449c70011bd8a8449934425aa27b9dd25d2a7e25a064afa1e665bf95f8b2eac4ec7cd63be4bcfdb7b8d

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-11-11 10:52:30 UTC using RuboCop version 1.68.0.
+# on 2024-11-25 13:01:09 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: 132
+# Offense count: 185
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
@@ -26,13 +26,12 @@ Lint/ConstantDefinitionInBlock:
     - 'spec/lutaml/model/validation_spec.rb'
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
 
-# Offense count: 2
+# Offense count: 1
 Lint/DuplicateMethods:
   Exclude:
-    - 'lib/lutaml/model/attribute.rb'
     - 'lib/lutaml/model/type/float.rb'
 
-# Offense count: 36
+# Offense count: 37
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
@@ -45,6 +44,7 @@ Metrics/AbcSize:
     - 'lib/lutaml/model/xml_adapter/nokogiri_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
+    - 'lib/lutaml/model/xml_mapping.rb'
     - 'lib/lutaml/model/xml_mapping_rule.rb'
 
 # Offense count: 6
@@ -53,7 +53,7 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 47
 
-# Offense count: 26
+# Offense count: 28
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
@@ -65,7 +65,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 53
+# Offense count: 55
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 46
@@ -75,7 +75,7 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 14
 
-# Offense count: 23
+# Offense count: 25
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
@@ -87,7 +87,7 @@ Metrics/PerceivedComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 7
+# Offense count: 8
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
@@ -97,7 +97,7 @@ RSpec/ContextWording:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_mapping_spec.rb'
 
-# Offense count: 117
+# Offense count: 127
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 54
@@ -127,16 +127,16 @@ RSpec/MultipleDescribes:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 149
+# Offense count: 153
 RSpec/MultipleExpectations:
   Max: 14
 
-# Offense count: 18
+# Offense count: 24
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 9
 
-# Offense count: 9
+# Offense count: 11
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 4
@@ -154,10 +154,9 @@ RSpec/PendingWithoutReason:
     - 'spec/lutaml/model/xml_adapter/xml_namespace_spec.rb'
     - 'spec/lutaml/model/xml_adapter_spec.rb'
 
-# Offense count: 2
+# Offense count: 1
 RSpec/RemoveConst:
   Exclude:
-    - 'spec/lutaml/model/type/decimal_spec.rb'
     - 'spec/lutaml/model/type_spec.rb'
 
 # Offense count: 2

data/README.adoc

@@ -874,6 +874,7 @@ class Example < Lutaml::Model::Serializable
 end
 ----
 
+
 === XML
 
 ==== Setting root element name
@@ -937,8 +938,7 @@ This includes:
 * attributes
 * text nodes
 
-The `map_all` tag is **exclusive** and cannot be combined with other mappings
-(`map_element`, `map_attribute`, `map_content`) for the same element, ensuring
+The `map_all` tag is **exclusive** and cannot be combined with other mappings (`map_element`, `map_content`) except for `map_attribute` for the same element, ensuring
 it captures the entire inner XML content.
 
 NOTE: An error is raised if `map_all` is defined alongside any other mapping in
@@ -1789,7 +1789,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 +1799,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.29"
   end
 end

data/lib/lutaml/model/xml_mapping.rb

@@ -3,6 +3,13 @@ require_relative "xml_mapping_rule"
 module Lutaml
   module Model
     class XmlMapping
+      TYPES = {
+        attribute: :map_attribute,
+        element: :map_element,
+        content: :map_content,
+        all_content: :map_all,
+      }.freeze
+
       attr_reader :root_element,
                   :namespace_uri,
                   :namespace_prefix,
@@ -53,7 +60,7 @@ module Lutaml
         prefix: (prefix_set = false
                  nil)
       )
-        validate!(name, to, with)
+        validate!(name, to, with, type: TYPES[:element])
 
         rule = XmlMappingRule.new(
           name,
@@ -84,7 +91,7 @@ module Lutaml
         prefix: (prefix_set = false
                  nil)
       )
-        validate!(name, to, with)
+        validate!(name, to, with, type: TYPES[:attribute])
 
         rule = XmlMappingRule.new(
           name,
@@ -114,7 +121,7 @@ module Lutaml
         mixed: false,
         cdata: false
       )
-        validate!("content", to, with)
+        validate!("content", to, with, type: TYPES[:content])
 
         @content_mapping = XmlMappingRule.new(
           nil,
@@ -139,7 +146,7 @@ module Lutaml
         prefix: (prefix_set = false
                  nil)
       )
-        validate!("__raw_mapping", to, with)
+        validate!("__raw_mapping", to, with, type: TYPES[:all_content])
 
         rule = XmlMappingRule.new(
           "__raw_mapping",
@@ -158,8 +165,8 @@ module Lutaml
         @raw_mapping = rule
       end
 
-      def validate!(key, to, with)
-        validate_mappings!(key)
+      def validate!(key, to, with, type: nil)
+        validate_mappings!(type)
 
         if to.nil? && with.empty?
           msg = ":to or :with argument is required for mapping '#{key}'"
@@ -172,13 +179,14 @@ module Lutaml
         end
       end
 
-      def validate_mappings!(key)
-        unless @raw_mapping.nil?
-          raise StandardError, "no other mappings are allowed with map_all"
+      def validate_mappings!(type)
+        if !@raw_mapping.nil? && type != TYPES[:attribute]
+          raise StandardError, "#{type} is not allowed, only #{TYPES[:attribute]} " \
+                               "is allowed with #{TYPES[:all_content]}"
         end
 
-        if !mappings.empty? && key == "__raw_mapping"
-          raise StandardError, "map_all is not allowed with other mappings"
+        if !(elements.empty? && content_mapping.nil?) && type == TYPES[:all_content]
+          raise StandardError, "#{TYPES[:all_content]} is not allowed with other mappings"
         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")

data/spec/lutaml/model/xml_mapping_spec.rb

@@ -179,6 +179,7 @@ module XmlMapping
 
   class WithMapAll < Lutaml::Model::Serializable
     attribute :all_content, :string
+    attribute :attr, :string
 
     xml do
       root "WithMapAll"
@@ -777,30 +778,34 @@ RSpec.describe Lutaml::Model::XmlMapping do
 
   describe "#map_all" do
     context "when map_all is defined before any other mapping" do
-      let(:error_message) { "no other mappings are allowed with map_all" }
-
       it "raise error when for map_element with map_all" do
         expect do
           XmlMapping::WithMapAll.xml do
             map_element "ele", to: :ele
           end
-        end.to raise_error(StandardError, error_message)
+        end.to raise_error(
+          StandardError,
+          "map_element is not allowed, only map_attribute is allowed with map_all",
+        )
       end
 
-      it "raise error when for map_attribute with map_all" do
+      it "raise error when for map_content with map_all" do
         expect do
           XmlMapping::WithMapAll.xml do
-            map_attribute "attr", to: :attr
+            map_content to: :text
           end
-        end.to raise_error(StandardError, error_message)
+        end.to raise_error(
+          StandardError,
+          "map_content is not allowed, only map_attribute is allowed with map_all",
+        )
       end
 
-      it "raise error when for map_content with map_all" do
+      it "does not raise error for map_attribute with map_all" do
         expect do
           XmlMapping::WithMapAll.xml do
-            map_content to: :text
+            map_attribute "attr", to: :attr
           end
-        end.to raise_error(StandardError, error_message)
+        end.not_to raise_error
       end
     end
 

metadata

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