lutaml-model 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b8569b5f2b450dfa8218c1c55a2175f154790220a54536bc9acbf6bc718312
-  data.tar.gz: d9d62e793690a72856e2663a67eb4eeb9cd8b909a861a91b093d8b849674a983
+  metadata.gz: 07d4f2ac62702a8ac27070d4d3246e59c367937cf50b649979ecb3c525f9b60e
+  data.tar.gz: 31adf8c870b4196ea69a065559ebbb5c2f35719aba3256597d9e24474bcbfa57
 SHA512:
-  metadata.gz: 5e491d76d913445b9929b4e1939becc31c4b1ccb656aeaaa3e83caa20bf3c5e53142c3cc45f1a82b0a85d4b7111ab6994d5a5c03588c4f42dd8f76d101c95db0
-  data.tar.gz: e18a44f0047929b93c2bc66c82f8942d3cf48818c6597722bba0b78107c2630aa59f84b3b4034a105155d889e64fa7e8f11881fbc9eca076b3103c21f8f189cf
+  metadata.gz: 5ef7e89a66c74f214202d44a5b8a55d7c2aedde5129e2723f36128e8651a019cd578df6d24c375b2f760f81cd9dcd2d85ed6ae5f8972345467c13466da71c527
+  data.tar.gz: 74aff7dee7711d4c9ec88730332b91f15ba530b92946b50b1cb218157856c1c31e3c6d9bdf292b8d9ab2832586c2ee61ae29d49a8254fecbd44cc92510f6667e

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-15 02:54:02 UTC using RuboCop version 1.71.2.
+# on 2025-02-21 10:20:24 UTC using RuboCop version 1.71.2.
 # 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
@@ -27,7 +27,7 @@ Layout/IndentationWidth:
   Exclude:
     - 'lib/lutaml/model/schema/xml_compiler.rb'
 
-# Offense count: 467
+# Offense count: 466
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -68,7 +68,7 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 46
 
-# Offense count: 48
+# Offense count: 47
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
@@ -85,7 +85,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/lutaml/model/xml_adapter/ox_adapter.rb'
     - 'lib/lutaml/model/xml_adapter/xml_document.rb'
 
-# Offense count: 87
+# Offense count: 86
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 45
@@ -95,7 +95,7 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 15
 
-# Offense count: 37
+# Offense count: 36
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:

data/README.adoc

@@ -347,6 +347,44 @@ same class and all their attributes are equal.
 
 == Defining attributes
 
+=== Derived Attributes
+
+A derived attribute is computed dynamically based on an instance method instead of storing a static value. It is defined using the `method:` option.
+
+Syntax:
+
+[source,ruby]
+----
+attribute :name_of_attribute, method: :instance_method_name
+----
+
+.Defining methods as attributes
+[example]
+====
+[source,ruby]
+----
+class Invoice < Lutaml::Model::Serializable
+  attribute :subtotal, :float
+  attribute :tax, :float
+  attribute :total, method: :total_value
+
+  def total_value
+    subtotal + tax
+  end
+end
+
+i = Invoice.new(subtotal: 100.0, tax: 12.0)
+i.total
+#=> 112.0
+
+puts i.to_yaml
+#=> ---
+#=> subtotal: 100.0
+#=> tax: 12.0
+#=> total: 112.0
+----
+====
+
 === Supported attribute value types
 
 ==== General types

data/lib/lutaml/model/attribute.rb

@@ -13,23 +13,20 @@ module Lutaml
         transform
         choice
         sequence
+        method_name
       ].freeze
 
       def initialize(name, type, options = {})
         @name = name
-
-        validate_type!(type)
-        @type = cast_type!(type)
-
-        validate_options!(options)
         @options = options
 
-        @raw = !!options[:raw]
+        validate_presence!(type, options[:method_name])
+        process_type!(type) if type
+        process_options!
+      end
 
-        if collection?
-          validate_collection_range
-          @options[:default] = -> { [] } unless options[:default]
-        end
+      def derived?
+        type.nil?
       end
 
       def delegate
@@ -40,6 +37,10 @@ module Lutaml
         @options[:transform] || {}
       end
 
+      def method_name
+        @options[:method_name]
+      end
+
       def cast_type!(type)
         case type
         when Symbol
@@ -231,20 +232,11 @@ module Lutaml
 
       def serialize(value, format, options = {})
         return if value.nil?
+        return value if derived?
+        return serialize_array(value, format, options) if value.is_a?(Array)
+        return serialize_model(value, format, options) if type <= Serialize
 
-        if value.is_a?(Array)
-          value.map do |v|
-            serialize(v, format, options)
-          end
-        elsif type <= Serialize
-          if Utils.present?(value)
-            type.public_send(:"as_#{format}", value, options)
-          end
-        else
-          # Convert to Value instance if not already
-          value = type.new(value) unless value.is_a?(Type::Value)
-          value.send(:"to_#{format}")
-        end
+        serialize_value(value, format)
       end
 
       def cast(value, format, options = {})
@@ -269,6 +261,41 @@ module Lutaml
           (format == :xml && value.is_a?(Lutaml::Model::XmlAdapter::XmlElement))
       end
 
+      def serialize_array(value, format, options)
+        value.map { |v| serialize(v, format, options) }
+      end
+
+      def serialize_model(value, format, options)
+        type.as(format, value, options) if Utils.present?(value)
+      end
+
+      def serialize_value(value, format)
+        value = type.new(value) unless value.is_a?(Type::Value)
+        value.send(:"to_#{format}")
+      end
+
+      def validate_presence!(type, method_name)
+        return if type || method_name
+
+        raise ArgumentError, "method or type must be set for an attribute"
+      end
+
+      def process_type!(type)
+        validate_type!(type)
+        @type = cast_type!(type)
+      end
+
+      def process_options!
+        validate_options!(@options)
+        @raw = !!@options[:raw]
+        set_default_for_collection if collection?
+      end
+
+      def set_default_for_collection
+        validate_collection_range
+        @options[:default] ||= -> { [] }
+      end
+
       def validate_options!(options)
         if (invalid_opts = options.keys - ALLOWED_OPTIONS).any?
           raise StandardError,
@@ -277,7 +304,8 @@ module Lutaml
 
         if options.key?(:pattern) && type != Lutaml::Model::Type::String
           raise StandardError,
-                "Invalid option `pattern` given for `#{name}`, `pattern` is only allowed for :string type"
+                "Invalid option `pattern` given for `#{name}`, " \
+                "`pattern` is only allowed for :string type"
         end
 
         true

data/lib/lutaml/model/serialize.rb

@@ -96,6 +96,11 @@ module Lutaml
 
         # Define an attribute for the model
         def attribute(name, type, options = {})
+          if type.is_a?(Hash)
+            options[:method_name] = type[:method]
+            type = nil
+          end
+
           attr = Attribute.new(name, type, options)
           attributes[name] = attr
 
@@ -106,6 +111,10 @@ module Lutaml
               options[:values],
               collection: options[:collection],
             )
+          elsif attr.derived? && name != attr.method_name
+            define_method(name) do
+              public_send(attr.method_name)
+            end
           else
             define_method(name) do
               instance_variable_get(:"@#{name}")
@@ -283,6 +292,10 @@ module Lutaml
           end
         end
 
+        def as(format, instance, options = {})
+          public_send(:"as_#{format}", instance, options)
+        end
+
         def key_value(&block)
           Lutaml::Model::Config::KEY_VALUE_FORMATS.each do |format|
             mappings[format] ||= KeyValueMapping.new
@@ -484,8 +497,7 @@ module Lutaml
           return instance unless doc
 
           if options[:default_namespace].nil?
-            options[:default_namespace] =
-              mappings_for(:xml)&.namespace_uri
+            options[:default_namespace] = mappings_for(:xml)&.namespace_uri
           end
           mappings = options[:mappings] || mappings_for(:xml).mappings
 
@@ -517,6 +529,7 @@ module Lutaml
             raise "Attribute '#{rule.to}' not found in #{self}" unless valid_rule?(rule)
 
             attr = attribute_for_rule(rule)
+            next if attr&.derived?
 
             value = if rule.raw_mapping?
                       doc.root.inner_xml
@@ -703,6 +716,8 @@ module Lutaml
         end
 
         self.class.attributes.each do |name, attr|
+          next if attr.derived?
+
           value = if attrs.key?(name) || attrs.key?(name.to_s)
                     attr_value(attrs, name, attr)
                   else

data/lib/lutaml/model/version.rb

@@ -2,6 +2,6 @@
 
 module Lutaml
   module Model
-    VERSION = "0.6.4"
+    VERSION = "0.6.5"
   end
 end

data/spec/lutaml/model/attribute_spec.rb

@@ -7,6 +7,10 @@ RSpec.describe Lutaml::Model::Attribute do
     described_class.new("name", :string)
   end
 
+  let(:method_attr) do
+    described_class.new("name", nil, method_name: nil)
+  end
+
   let(:test_record_class) do
     Class.new(Lutaml::Model::Serializable) do
       attribute :age, :integer
@@ -33,6 +37,13 @@ RSpec.describe Lutaml::Model::Attribute do
       .to("avatar.png")
   end
 
+  it "raises error if both type and method_name are not given" do
+    expect { method_attr }.to raise_error(
+      ArgumentError,
+      "method or type must be set for an attribute",
+    )
+  end
+
   describe "#validate_options!" do
     let(:validate_options) { name_attr.method(:validate_options!) }
 
@@ -103,7 +114,25 @@ RSpec.describe Lutaml::Model::Attribute do
     end
   end
 
-  describe "#default?" do
+  describe "#derived?" do
+    context "when type is set" do
+      let(:attribute) { described_class.new("name", :string) }
+
+      it "returns false" do
+        expect(attribute.derived?).to be(false)
+      end
+    end
+
+    context "when type is nil and method_name is set" do
+      let(:attribute) { described_class.new("name", nil, method_name: :tmp) }
+
+      it "returns true" do
+        expect(attribute.derived?).to be(true)
+      end
+    end
+  end
+
+  describe "#default" do
     context "when default is not set" do
       let(:attribute) { described_class.new("name", :string) }
 

data/spec/lutaml/model/serializable_spec.rb

@@ -112,13 +112,42 @@ RSpec.describe Lutaml::Model::Serializable do
   end
 
   describe ".attribute" do
-    subject(:mapper) { described_class.new }
+    before do
+      stub_const("TestClass", Class.new(described_class))
+    end
+
+    context "when method_name is given" do
+      let(:attribute) do
+        TestClass.attribute("test", method: :foobar)
+      end
 
-    it "adds the attribute and getter setter for that attribute" do
-      expect { described_class.attribute("foo", Lutaml::Model::Type::String) }
-        .to change { described_class.attributes.keys }.from([]).to(["foo"])
-        .and change { mapper.respond_to?(:foo) }.from(false).to(true)
-        .and change { mapper.respond_to?(:foo=) }.from(false).to(true)
+      it "adds derived attribute" do
+        expect { attribute }
+          .to change { TestClass.attributes["test"] }
+          .from(nil)
+          .to(Lutaml::Model::Attribute)
+      end
+
+      it "returns true for derived?" do
+        expect(attribute.derived?).to be(true)
+      end
+    end
+
+    context "when type is given" do
+      let(:attribute) do
+        TestClass.attribute("foo", Lutaml::Model::Type::String)
+      end
+
+      it "adds the attribute and getter setter for that attribute" do
+        expect { attribute }
+          .to change { TestClass.attributes.keys }.from([]).to(["foo"])
+          .and change { TestClass.new.respond_to?(:foo) }.from(false).to(true)
+          .and change { TestClass.new.respond_to?(:foo=) }.from(false).to(true)
+      end
+
+      it "returns false for derived?" do
+        expect(attribute.derived?).to be(false)
+      end
     end
   end
 

data/spec/lutaml/model/xml/derived_attributes_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module DerivedAttributesSpecs
+  class Ceramic < Lutaml::Model::Serializable
+    attribute :name, :string
+    attribute :value, :float
+  end
+
+  class CeramicCollection < Lutaml::Model::Serializable
+    attribute :items, Ceramic, collection: true
+    attribute :total_value, method: :total_value
+
+    # Derived property
+    def total_value
+      items.sum(&:value)
+    end
+
+    xml do
+      root "ceramic-collection"
+      map_element "total-value", to: :total_value
+      map_element "item", to: :items
+    end
+  end
+end
+
+RSpec.describe "XML::DerivedAttributes" do
+  let(:xml) do
+    <<~XML.strip
+      <ceramic-collection>
+        <total-value>2500.0</total-value>
+        <item>
+          <name>Ancient Vase</name>
+          <value>1500.0</value>
+        </item>
+        <item>
+          <name>Historic Bowl</name>
+          <value>1000.0</value>
+        </item>
+      </ceramic-collection>
+    XML
+  end
+
+  let(:ancient_vase) do
+    DerivedAttributesSpecs::Ceramic.new(name: "Ancient Vase", value: 1500.0)
+  end
+
+  let(:historic_bowl) do
+    DerivedAttributesSpecs::Ceramic.new(name: "Historic Bowl", value: 1000.0)
+  end
+
+  let(:ceramic_collection) do
+    DerivedAttributesSpecs::CeramicCollection.new(
+      items: [ancient_vase, historic_bowl],
+    )
+  end
+
+  describe ".from_xml" do
+    let(:parsed) do
+      DerivedAttributesSpecs::CeramicCollection.from_xml(xml)
+    end
+
+    it "correctly parses items" do
+      expect(parsed).to eq(ceramic_collection)
+    end
+
+    it "correctly calculates total-value" do
+      expect(parsed.total_value).to eq(2500)
+    end
+  end
+
+  describe ".to_xml" do
+    it "convert to correct xml" do
+      expect(ceramic_collection.to_xml).to eq(xml)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lutaml-model
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Ribose Inc.
@@ -257,6 +257,7 @@ files:
 - spec/lutaml/model/utils_spec.rb
 - spec/lutaml/model/validation_spec.rb
 - spec/lutaml/model/with_child_mapping_spec.rb
+- spec/lutaml/model/xml/derived_attributes_spec.rb
 - spec/lutaml/model/xml_adapter/nokogiri_adapter_spec.rb
 - spec/lutaml/model/xml_adapter/oga_adapter_spec.rb
 - spec/lutaml/model/xml_adapter/ox_adapter_spec.rb