lutaml-model 0.7.3 → 0.7.5

data/lib/lutaml/model.rb

@@ -2,6 +2,7 @@
 
 require "moxml"
 require_relative "model/uninitialized_class"
+require_relative "model/errors"
 require_relative "model/services"
 require_relative "model/version"
 require_relative "model/type"
@@ -11,13 +12,17 @@ require_relative "model/xml_adapter"
 require_relative "model/error"
 require_relative "model/constants"
 require_relative "model/config"
+require_relative "model/global_register"
+require_relative "model/register"
 require_relative "model/format_registry"
-
+require_relative "model/collection"
 require_relative "model/key_value_document"
 require_relative "model/yaml"
+require_relative "model/yamls"
 require_relative "model/json"
+require_relative "model/jsonl"
 require_relative "model/toml"
-require_relative "model/hash"
+require_relative "model/hash_adapter"
 require_relative "model/xml"
 
 module Lutaml
@@ -30,34 +35,5 @@ module Lutaml
 
     class BaseModel < Serializable
     end
-
-    # Register default adapters
-    # Lutaml::Model::FormatRegistry.register(
-    #   :json,
-    #   mapping_class: KeyValueMapping,
-    #   adapter_class: JsonAdapter::StandardJsonAdapter,
-    #   transformer: Lutaml::Model::KeyValueTransform,
-    # )
-
-    # Lutaml::Model::FormatRegistry.register(
-    #   :yaml,
-    #   mapping_class: KeyValueMapping,
-    #   adapter_class: YamlAdapter::StandardYamlAdapter,
-    #   transformer: Lutaml::Model::KeyValueTransform,
-    # )
-
-    # Lutaml::Model::FormatRegistry.register(
-    #   :toml,
-    #   mapping_class: KeyValueMapping,
-    #   adapter_class: nil,
-    #   transformer: Lutaml::Model::KeyValueTransform,
-    # )
-
-    # Lutaml::Model::FormatRegistry.register(
-    #   :xml,
-    #   mapping_class: XmlMapping,
-    #   adapter_class: nil,
-    #   transformer: Lutaml::Model::XmlTransform,
-    # )
   end
 end

data/spec/benchmarks/xml_parsing_benchmark_spec.rb

@@ -5,7 +5,7 @@ require "lutaml/model/xml/oga_adapter"
 
 RSpec.describe "LutaML Model Performance" do
   after do
-    Lutaml::Model::Config.xml_adapter = Lutaml::Model::Xml::NokogiriAdapter
+    Lutaml::Model::Config.xml_adapter_type = :nokogiri
   end
 
   let(:large_xml) do
@@ -26,7 +26,6 @@ RSpec.describe "LutaML Model Performance" do
       map_attribute "id", to: :id
       map_element "value", to: :value
       map_element "name", to: :name
-      map_element "value", to: :value
     end
   end
 
@@ -48,12 +47,12 @@ RSpec.describe "LutaML Model Performance" do
       end
 
       x.report("Ox Adapter") do
-        Lutaml::Model::Config.xml_adapter = Lutaml::Model::Xml::OxAdapter
+        Lutaml::Model::Config.xml_adapter_type = :ox
         Deserializer.from_xml(large_xml)
       end
 
       x.report("Oga Adapter") do
-        Lutaml::Model::Config.xml_adapter = Lutaml::Model::Xml::OgaAdapter
+        Lutaml::Model::Config.xml_adapter_type = :oga
         Deserializer.from_xml(large_xml)
       end
 
@@ -62,7 +61,7 @@ RSpec.describe "LutaML Model Performance" do
 
     thresholds = {
       "Nokogiri Adapter" => 3,
-      "Ox Adapter" => 7,
+      "Ox Adapter" => 6,
       "Oga Adapter" => 3,
     }
 

data/spec/fixtures/xml/advanced_test_schema.xsd

@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+  xmlns:test="http://www.example.com/test" targetNamespace="http://www.example.com/test" elementFormDefault="qualified">
+
+  <!-- Advanced Simple Types -->
+  <xs:simpleType name="StringOrInteger">
+    <xs:union memberTypes="xs:string xs:integer"/>
+  </xs:simpleType>
+
+  <xs:simpleType name="ColorList">
+    <xs:list itemType="xs:string"/>
+  </xs:simpleType>
+
+  <xs:simpleType name="RestrictedString">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="[A-Z][a-z]+"/>
+      <xs:minLength value="2"/>
+      <xs:maxLength value="20"/>
+    </xs:restriction>
+  </xs:simpleType>
+
+  <!-- Base Complex Types -->
+  <xs:complexType name="BaseType">
+    <xs:sequence>
+      <xs:element name="id" type="xs:integer"/>
+      <xs:element name="name" type="test:RestrictedString"/>
+    </xs:sequence>
+    <xs:attribute name="version" type="xs:string" use="optional"/>
+  </xs:complexType>
+
+  <!-- Extension using complexContent -->
+  <xs:complexType name="ExtendedType">
+    <xs:complexContent>
+      <xs:extension base="test:BaseType">
+        <xs:sequence>
+          <xs:element name="description" type="xs:string"/>
+          <xs:element name="tags" type="test:ColorList"/>
+        </xs:sequence>
+        <xs:attribute name="priority" type="xs:integer" use="required"/>
+      </xs:extension>
+    </xs:complexContent>
+  </xs:complexType>
+
+  <!-- Restriction using complexContent -->
+  <xs:complexType name="RestrictedType">
+    <xs:complexContent>
+      <xs:restriction base="test:BaseType">
+        <xs:sequence>
+          <xs:element name="id" type="xs:positiveInteger"/>
+          <xs:element name="name" type="test:RestrictedString"/>
+        </xs:sequence>
+        <xs:attribute name="version" type="xs:string" fixed="1.0"/>
+      </xs:restriction>
+    </xs:complexContent>
+  </xs:complexType>
+
+  <!-- Mixed Content Type -->
+  <xs:complexType name="MixedContentType" mixed="true">
+    <xs:sequence>
+      <xs:element name="bold" type="xs:string" minOccurs="0"/>
+      <xs:element name="italic" type="xs:string" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <!-- Group Definitions -->
+  <xs:group name="CommonElements">
+    <xs:sequence>
+      <xs:element name="created" type="xs:dateTime"/>
+      <xs:element name="modified" type="xs:dateTime"/>
+    </xs:sequence>
+  </xs:group>
+
+  <!-- Attribute Group -->
+  <xs:attributeGroup name="CommonAttributes">
+    <xs:attribute name="id" type="xs:ID" use="required"/>
+    <xs:attribute name="type" type="xs:string" use="optional"/>
+  </xs:attributeGroup>
+
+  <!-- Complex Type with Groups -->
+  <xs:complexType name="GroupedType">
+    <xs:sequence>
+      <xs:group ref="test:CommonElements"/>
+      <xs:element name="content" type="xs:string"/>
+    </xs:sequence>
+    <xs:attributeGroup ref="test:CommonAttributes"/>
+  </xs:complexType>
+
+  <!-- Choice Element -->
+  <xs:complexType name="ChoiceType">
+    <xs:choice minOccurs="1" maxOccurs="unbounded">
+      <xs:element name="text" type="xs:string"/>
+      <xs:element name="number" type="xs:integer"/>
+      <xs:element name="date" type="xs:date"/>
+    </xs:choice>
+  </xs:complexType>
+
+  <!-- All Element -->
+  <xs:complexType name="AllType">
+    <xs:all>
+      <xs:element name="first" type="xs:string"/>
+      <xs:element name="second" type="xs:integer"/>
+      <xs:element name="third" type="xs:boolean"/>
+    </xs:all>
+  </xs:complexType>
+
+  <!-- Root Elements -->
+  <xs:element name="TestDocument">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="base" type="test:BaseType"/>
+        <xs:element name="extended" type="test:ExtendedType"/>
+        <xs:element name="restricted" type="test:RestrictedType"/>
+        <xs:element name="mixed" type="test:MixedContentType"/>
+        <xs:element name="grouped" type="test:GroupedType"/>
+        <xs:element name="choice" type="test:ChoiceType"/>
+        <xs:element name="all" type="test:AllType"/>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+
+  <!-- Alternative Root with Substitution Group -->
+  <xs:element name="AlternativeDocument" substitutionGroup="test:TestDocument">
+    <xs:complexType>
+      <xs:complexContent>
+        <xs:extension base="test:TestDocument">
+          <xs:sequence>
+            <xs:element name="additional" type="xs:string"/>
+          </xs:sequence>
+        </xs:extension>
+      </xs:complexContent>
+    </xs:complexType>
+  </xs:element>
+
+</xs:schema> 

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