lutaml-model 0.7.1 → 0.7.7

data/spec/fixtures/xml/examples/nested_categories.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0"?>
+<ProductCatalog version="1.0" lastUpdated="2024-03-20T10:00:00+00:00">
+  <categories>
+    <category>
+      <id>1</id>
+      <name>Electronics</name>
+      <parentCategory>0</parentCategory>
+      <description>Electronic devices and accessories</description>
+    </category>
+    <category>
+      <id>2</id>
+      <name>Smartphones</name>
+      <parentCategory>1</parentCategory>
+      <description>Mobile phones and accessories</description>
+    </category>
+    <category>
+      <id>3</id>
+      <name>Laptops</name>
+      <parentCategory>1</parentCategory>
+      <description>Portable computers and accessories</description>
+    </category>
+  </categories>
+  <products>
+    <product id="1" status="active">
+      <sku>PHN12345678</sku>
+      <name>Smartphone Pro</name>
+      <description>Latest smartphone model</description>
+      <category>
+        <id>2</id>
+        <name>Smartphones</name>
+        <parentCategory>1</parentCategory>
+        <description>Mobile phones and accessories</description>
+      </category>
+      <price>99.99</price>
+      <salePrice>89.99</salePrice>
+      <inventory>50</inventory>
+      <dimensions>
+        <length>14.5</length>
+        <width>7.0</width>
+        <height>0.7</height>
+        <weight>0.18</weight>
+      </dimensions>
+      <rating>4.5</rating>
+      <features>
+        <feature>5G Connectivity</feature>
+        <feature>128GB Storage</feature>
+        <feature>Triple Camera System</feature>
+      </features>
+      <images>
+        <image url="https://example.com/images/smartphone-pro-1.jpg" alt="Smartphone Pro Front View" isPrimary="true"/>
+        <image url="https://example.com/images/smartphone-pro-2.jpg" alt="Smartphone Pro Back View"/>
+      </images>
+    </product>
+  </products>
+</ProductCatalog>

data/spec/fixtures/xml/examples/valid_catalog.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ProductCatalog version="1.0" lastUpdated="2024-03-20T10:00:00+00:00">
+  <categories>
+    <category>
+      <id>1</id>
+      <name>Electronics</name>
+      <parentCategory>0</parentCategory>
+      <description>Electronic devices and accessories</description>
+    </category>
+  </categories>
+  <products>
+    <product id="1" status="active">
+      <sku>ABC12345678</sku>
+      <name>Smartphone X</name>
+      <description>A high-end smartphone with advanced features</description>
+      <category>
+        <id>1</id>
+        <name>Electronics</name>
+        <parentCategory>0</parentCategory>
+        <description>Electronic devices and accessories</description>
+      </category>
+      <price>99.99</price>
+      <salePrice>89.99</salePrice>
+      <inventory>100</inventory>
+      <dimensions>
+        <length>15.0</length>
+        <width>7.5</width>
+        <height>0.8</height>
+        <weight>0.2</weight>
+      </dimensions>
+      <rating>4.5</rating>
+      <features>
+        <feature>5G Connectivity</feature>
+        <feature>128GB Storage</feature>
+        <feature>Triple Camera System</feature>
+      </features>
+      <images>
+        <image url="https://example.com/images/smartphone-x-1.jpg" alt="Smartphone X Front View" isPrimary="true"/>
+        <image url="https://example.com/images/smartphone-x-2.jpg" alt="Smartphone X Back View"/>
+      </images>
+    </product>
+  </products>
+</ProductCatalog>

data/spec/fixtures/xml/product_catalog.xsd

@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+  xmlns:cat="http://www.example.com/catalog" targetNamespace="http://www.example.com/catalog" elementFormDefault="qualified">
+
+  <!-- Attributes -->
+  <xs:attribute name="id" type="xs:integer" use="required"/>
+
+  <!-- Simple Types -->
+  <xs:simpleType name="SKUType">
+    <xs:annotation>
+      <xs:documentation>Stock Keeping Unit - must be 8-12 alphanumeric characters</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:string">
+      <xs:pattern value="[A-Z0-9]{8,12}"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="PriceType">
+    <xs:annotation>
+      <xs:documentation>Price with 2 decimal places, must be positive</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:decimal">
+      <xs:maxExclusive value="101.00"/>
+      <xs:minInclusive value="0.01"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="QuantityTypes">
+    <xs:annotation>
+      <xs:documentation>Quantity must be non-negative</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:integer">
+      <xs:minInclusive value="0"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <xs:simpleType name="RatingType">
+    <xs:annotation>
+      <xs:documentation>Product rating from 1 to 5</xs:documentation>
+    </xs:annotation>
+    <xs:restriction base="xs:decimal">
+      <xs:minInclusive value="1"/>
+      <xs:maxInclusive value="5"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <!-- Complex Types -->
+  <xs:complexType name="DimensionsType">
+    <xs:sequence>
+      <xs:choice minOccurs="0" maxOccurs="unbounded">
+        <xs:choice maxOccurs="unbounded">
+          <xs:element name="length" type="xs:decimal">
+            <xs:annotation>
+              <xs:documentation>Length in centimeters</xs:documentation>
+            </xs:annotation>
+          </xs:element>
+        </xs:choice>
+        <xs:element name="width" type="xs:decimal">
+          <xs:annotation>
+            <xs:documentation>Width in centimeters</xs:documentation>
+          </xs:annotation>
+        </xs:element>
+      </xs:choice>
+      <xs:element name="height" type="xs:decimal">
+        <xs:annotation>
+          <xs:documentation>Height in centimeters</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="weight" type="xs:decimal">
+        <xs:annotation>
+          <xs:documentation>Weight in kilograms</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+    </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="CategoryType">
+    <xs:sequence>
+      <xs:element name="id" type="xs:integer"/>
+      <xs:element name="name" type="xs:string"/>
+      <xs:element name="parentCategory" type="xs:integer" minOccurs="0"/>
+      <xs:element name="description" type="xs:string" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="ProductType">
+    <xs:sequence>
+      <xs:element name="sku" type="cat:SKUType"/>
+      <xs:element name="name" type="xs:string"/>
+      <xs:element name="description" type="xs:string"/>
+      <xs:element name="category" type="cat:CategoryType"/>
+      <xs:element name="price" type="cat:PriceType"/>
+      <xs:element name="salePrice" type="cat:PriceType" minOccurs="0"/>
+      <xs:element name="inventory" type="cat:QuantityTypes"/>
+      <xs:element name="dimensions" type="cat:DimensionsType"/>
+      <xs:element name="rating" type="cat:RatingType" minOccurs="0"/>
+      <xs:element name="features" minOccurs="0">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="feature" type="xs:string" maxOccurs="unbounded"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+      <xs:element name="images" minOccurs="0">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="image" maxOccurs="unbounded">
+              <xs:complexType>
+                <xs:attribute name="url" type="xs:anyURI" use="required"/>
+                <xs:attribute name="alt" type="xs:string" use="required"/>
+                <xs:attribute name="isPrimary" type="xs:boolean" default="false"/>
+              </xs:complexType>
+            </xs:element>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+    </xs:sequence>
+    <!-- using 'ref' for development purposes only -->
+    <xs:attribute ref="id"/>
+    <xs:attribute name="status" use="required">
+      <xs:simpleType>
+        <xs:restriction base="xs:string">
+          <xs:enumeration value="active"/>
+          <xs:enumeration value="inactive"/>
+          <xs:enumeration value="discontinued"/>
+        </xs:restriction>
+      </xs:simpleType>
+    </xs:attribute>
+  </xs:complexType>
+
+  <xs:complexType name="ProductCatalog" mixed="true">
+    <xs:sequence>
+      <xs:element name="categories">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="category" type="cat:CategoryType" maxOccurs="unbounded"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+      <xs:element name="products">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="product" type="cat:ProductType" maxOccurs="unbounded"/>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+    </xs:sequence>
+    <xs:attribute name="version" type="xs:string" use="required"/>
+    <xs:attribute name="lastUpdated" type="xs:dateTime" use="required"/>
+  </xs:complexType>
+</xs:schema>

data/spec/fixtures/xml/specifications_schema.xsd

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://example.com/specs"
+  xmlns="http://example.com/specs" elementFormDefault="qualified">
+  <!-- ComplexType SpecBase and ShortSpec are root elements -->
+
+  <!-- Base type for a specification -->
+  <xs:complexType name="spec">
+    <xs:sequence>
+      <xs:element name="title" type="xs:string"/>
+      <xs:element name="version" type="xs:string"/>
+      <xs:element name="status" type="status" minOccurs="0" default="draft"/>
+    </xs:sequence>
+    <xs:attribute name="id" type="xs:ID" use="required"/>
+  </xs:complexType>
+
+  <!-- Restriction: A "ShortSpec" only allows title and version, not status -->
+  <xs:complexType name="shortSpec">
+    <xs:complexContent>
+      <xs:restriction base="spec">
+        <xs:sequence>
+          <xs:element name="title" type="xs:string"/>
+          <xs:element name="version" type="xs:string"/>
+          <xs:element name="status" type="status" minOccurs="0" maxOccurs="2"/>
+        </xs:sequence>
+        <xs:attribute name="id" type="xs:ID" use="required"/>
+      </xs:restriction>
+    </xs:complexContent>
+  </xs:complexType>
+
+  <!-- Enumeration for status -->
+  <xs:simpleType name="status">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="draft"/>
+      <xs:enumeration value="final"/>
+      <xs:enumeration value="archived"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>

data/spec/lutaml/model/attribute_collection_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+require "lutaml/model"
+
+module AttributeCollection
+  class StringParts < Lutaml::Model::Collection
+    instances :parts, :string
+
+    def to_s
+      parts.join(" -- ")
+    end
+  end
+
+  class BibliographicItem < Lutaml::Model::Serializable
+    attribute :title_parts, :string, collection: StringParts
+
+    xml do
+      root "titles"
+      map_element "title", to: :title_parts
+    end
+
+    key_value do
+      root "titles"
+      map_instances to: :title_parts
+    end
+
+    def render_title
+      title_parts.to_s
+    end
+  end
+end
+
+RSpec.describe AttributeCollection do
+  let(:xml_data) do
+    <<~XML
+      <titles>
+        <title>Title One</title>
+        <title>Title Two</title>
+        <title>Title Three</title>
+      </titles>
+    XML
+  end
+
+  let(:yaml_data) do
+    <<~YAML
+      ---
+      titles:
+      - Title One
+      - Title Two
+      - Title Three
+    YAML
+  end
+
+  describe "BibliographicItem with custom collection" do
+    let(:bib_item) { AttributeCollection::BibliographicItem.from_xml(xml_data) }
+
+    it "initializes with custom collection class" do
+      expect(bib_item.title_parts).to be_a(AttributeCollection::StringParts)
+    end
+
+    it "contains the correct number of title parts" do
+      expect(bib_item.title_parts.count).to eq(3)
+    end
+
+    it "contains the correct title parts" do
+      expect(bib_item.title_parts.parts).to eq(["Title One", "Title Two", "Title Three"])
+    end
+
+    it "renders title with custom separator" do
+      expect(bib_item.render_title).to eq("Title One -- Title Two -- Title Three")
+    end
+
+    it "serializes to XML correctly" do
+      expect(bib_item.to_xml.strip).to eq(xml_data.strip)
+    end
+
+    it "deserializes from YAML correctly" do
+      yaml_bib_item = AttributeCollection::BibliographicItem.from_yaml(yaml_data)
+      expect(yaml_bib_item.title_parts.parts).to eq(["Title One", "Title Two", "Title Three"])
+    end
+
+    it "serializes to YAML correctly" do
+      expect(bib_item.to_yaml.strip).to eq(yaml_data.strip)
+    end
+
+    it "can be initialized with an array of strings" do
+      bib_item = AttributeCollection::BibliographicItem.new(
+        title_parts: AttributeCollection::StringParts.new(
+          ["Part One", "Part Two"],
+        ),
+      )
+
+      expect(bib_item.title_parts.parts).to eq(["Part One", "Part Two"])
+    end
+
+    it "can be initialized with a custom collection instance" do
+      collection = AttributeCollection::StringParts.new(["Custom One", "Custom Two"])
+      bib_item = AttributeCollection::BibliographicItem.new(title_parts: collection)
+      expect(bib_item.title_parts.parts).to eq(["Custom One", "Custom Two"])
+    end
+  end
+end

data/spec/lutaml/model/attribute_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Lutaml::Model::Attribute do
     Class.new(Lutaml::Model::Serializable) do
       attribute :age, :integer
       attribute :image, :string
+      restrict :image, collection: 1..., pattern: /.*\.\w+$/
     end
   end
 
@@ -44,6 +45,45 @@ RSpec.describe Lutaml::Model::Attribute do
     )
   end
 
+  describe "#validate_name!" do
+    Lutaml::Model::Serializable.instance_methods.each do |method|
+      if Lutaml::Model::Attribute::ALLOW_OVERRIDING.include?(method)
+        before do
+          allow(Lutaml::Model::Logger).to receive(:warn)
+        end
+
+        it "does not raise an error when method is `#{method}`" do
+          expect do
+            Class.new(Lutaml::Model::Serializable) do
+              attribute method, :string
+            end
+          end.not_to raise_error
+        end
+
+        it "logs a warning, when method is `#{method}`" do
+          Class.new(Lutaml::Model::Serializable) do
+            attribute method, :string
+          end
+
+          expect(Lutaml::Model::Logger)
+            .to have_received(:warn)
+            .with("Attribute name `#{method}` conflicts with a built-in method")
+        end
+      else
+        it "raise exception, when method is `#{method}`" do
+          expect do
+            Class.new(Lutaml::Model::Serializable) do
+              attribute method, :string
+            end
+          end.to raise_error(
+            Lutaml::Model::InvalidAttributeNameError,
+            "Attribute name '#{method}' is not allowed",
+          )
+        end
+      end
+    end
+  end
+
   describe "#validate_options!" do
     let(:validate_options) { name_attr.method(:validate_options!) }
 
@@ -56,7 +96,7 @@ RSpec.describe Lutaml::Model::Attribute do
     it "raise exception if option is not allowed" do
       expect do
         validate_options.call({ foo: "bar" })
-      end.to raise_error(StandardError, "Invalid options given for `name` [:foo]")
+      end.to raise_error(Lutaml::Model::InvalidAttributeOptionsError, "Invalid options given for `name` [:foo]")
     end
 
     it "raise exception if pattern is given with non string type" do
@@ -71,49 +111,6 @@ RSpec.describe Lutaml::Model::Attribute do
     end
   end
 
-  describe "#validate_type!" do
-    let(:validate_type) { name_attr.method(:validate_type!) }
-
-    it "return true if type is a class" do
-      expect(validate_type.call(TestRecord)).to be(true)
-    end
-
-    it "return true if type is a valid symbol" do
-      expect(validate_type.call(:string)).to be(true)
-    end
-
-    it "return true if type is a valid string" do
-      expect(validate_type.call("String")).to be(true)
-    end
-
-    it "raise exception if type is invalid symbol" do
-      expect do
-        validate_type.call(:foo)
-      end.to raise_error(StandardError, "Unknown Lutaml::Model::Type: foo")
-    end
-
-    it "raise exception if type is invalid string" do
-      expect do
-        validate_type.call("foo")
-      end.to raise_error(StandardError, "Unknown Lutaml::Model::Type: foo")
-    end
-  end
-
-  describe "#cast_type!" do
-    it "cast :string to Lutaml::Model::Type::String" do
-      expect(name_attr.cast_type!(:string)).to eq(Lutaml::Model::Type::String)
-    end
-
-    it "cast :integer to Lutaml::Model::Type::Integer" do
-      expect(name_attr.cast_type!(:integer)).to eq(Lutaml::Model::Type::Integer)
-    end
-
-    it "raises ArgumentError on unknown type" do
-      expect { name_attr.cast_type!(:foobar) }
-        .to raise_error(ArgumentError, "Unknown Lutaml::Model::Type: foobar")
-    end
-  end
-
   describe "#derived?" do
     context "when type is set" do
       let(:attribute) { described_class.new("name", :string) }

data/spec/lutaml/model/cdata_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 require "lutaml/model"
-require "lutaml/model/xml_adapter/nokogiri_adapter"
-require "lutaml/model/xml_adapter/ox_adapter"
+require "lutaml/model/xml/nokogiri_adapter"
+require "lutaml/model/xml/ox_adapter"
 
 module CDATA
   class Beta < Lutaml::Model::Serializable
@@ -350,7 +350,7 @@ RSpec.describe "CDATA" do
           instance = parent_mapper.from_xml(input_xml)
           result_xml = parent_mapper.to_xml(instance)
 
-          expected_output = adapter_class == Lutaml::Model::XmlAdapter::OxAdapter ? expected_ox_xml : expected_nokogiri_xml
+          expected_output = adapter_class == Lutaml::Model::Xml::OxAdapter ? expected_ox_xml : expected_nokogiri_xml
 
           expect(result_xml.strip).to eq(expected_output.strip)
         end
@@ -439,7 +439,7 @@ RSpec.describe "CDATA" do
 
           # due to the difference in capturing
           # newlines in ox and nokogiri adapters
-          if adapter_class == Lutaml::Model::XmlAdapter::OxAdapter
+          if adapter_class == Lutaml::Model::Xml::OxAdapter
             expected_xml = expected_ox_xml
           end
 
@@ -496,7 +496,7 @@ RSpec.describe "CDATA" do
 
           # due to the difference in capturing
           # newlines in ox and nokogiri adapters
-          if adapter_class == Lutaml::Model::XmlAdapter::OxAdapter
+          if adapter_class == Lutaml::Model::Xml::OxAdapter
             expected_xml = expected_ox_xml
           end
 
@@ -509,11 +509,11 @@ RSpec.describe "CDATA" do
     end
   end
 
-  describe Lutaml::Model::XmlAdapter::NokogiriAdapter do
+  describe Lutaml::Model::Xml::NokogiriAdapter do
     it_behaves_like "cdata behavior", described_class
   end
 
-  describe Lutaml::Model::XmlAdapter::OxAdapter do
+  describe Lutaml::Model::Xml::OxAdapter do
     it_behaves_like "cdata behavior", described_class
   end
 end

data/spec/lutaml/model/choice_spec.rb

@@ -59,6 +59,29 @@ module ChoiceSpec
       map :last_name, to: :last_name
     end
   end
+
+  class ContactEmail < Lutaml::Model::Serializable
+    attribute :email, :string
+    xml { no_root }
+  end
+
+  class ContactPhone < Lutaml::Model::Serializable
+    attribute :phone, :string
+    xml { no_root }
+  end
+
+  class Person < Lutaml::Model::Serializable
+    choice(min: 1, max: 2) do
+      import_model_attributes ContactEmail
+      import_model_attributes ContactPhone
+    end
+
+    xml do
+      root "Person"
+      map_element :email, to: :email
+      map_element :phone, to: :phone
+    end
+  end
 end
 
 RSpec.describe "Choice" do
@@ -165,4 +188,25 @@ RSpec.describe "Choice" do
       end.to raise_error(Lutaml::Model::InvalidChoiceRangeError, "Choice lower bound `-1` must be positive")
     end
   end
+
+  context "with choice using import_model_attributes" do
+    it "parses XML with both email and phone using choice and import_model_attributes" do
+      xml = <<~XML
+        <Person>
+          <email>john.doe@example.com</email>
+          <phone>1234567890</phone>
+        </Person>
+      XML
+      person = ChoiceSpec::Person.from_xml(xml)
+      expect(person.email).to eq("john.doe@example.com")
+      expect(person.phone).to eq("1234567890")
+    end
+
+    it "raises error if no contact info is provided" do
+      xml = <<~XML
+        <Person></Person>
+      XML
+      expect { ChoiceSpec::Person.from_xml(xml).validate! }.to raise_error(Lutaml::Model::ValidationError)
+    end
+  end
 end