lutaml-model 0.8.126 → 0.8.128

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b25c117248ae09d0b9a264e2d28fd7a34e8701e97c745c0169c92e53309a70b
-  data.tar.gz: ca1949cf1b6b3ad95b3640c14ed80ef34f6d741e7f6d66b50b9ad6d7a42664f1
+  metadata.gz: d822754e3a7baeb6edb87dcfa7fb61c90c5da8b44920b2ad612905cb8ee9a278
+  data.tar.gz: ef8bcf9d531357fcd8d3fd07fc5053015c1b0e6202530866adf01f7e932123de
 SHA512:
-  metadata.gz: dc5fe5fc88f3a1744f61e447dbb863f22f2d3314086b681d785d90e62f1ca2ef1e42bb156edae5bbd6f920ea3628f877623a16a0f8bfa49022ca93200eda887d
-  data.tar.gz: 46c3f3966f2d7bf6a14292cb311544d40b5bdb561dd9a0a17c21d06ac257fd71ff9d1e427bb14697e781888c2aaade62a2e28c6bdbea2e89e316645b4c366428
+  metadata.gz: 9c4c5d63a666d0b8b99279de9dcf7fbee3031b694abba3729636249f701a4f67388507c13c778318f61d22ac1ce9a21940bf35960299e2a569fb024e302e3560
+  data.tar.gz: 7eb201762de275df248d27f7fc7c5e1019cd65e63822059b7075a69aae661d8a18f8123522797155665d8688d8147a6e06d46fdffde8fbc35e9f4347bd8424b9

data/README.adoc

@@ -830,6 +830,19 @@ Every type has a corresponding Ruby class and a serialization format type.
 | `:qname`              | `Lutaml::Model::Type::QName` | `xs:QName`    | `string`  | `string`  | `"prefix:localName"`
 | `:base64_binary`      | `String`                 | `xs:base64Binary` | `string`  | `string`  | `"SGVsbG8gV29ybGQ="`
 | `:hex_binary`         | `String`                 | `xs:hexBinary`    | `string`  | `string`  | `"48656c6c6f"`
+| `:email_address`      | `String`                 | `xs:string`       | `string`  | `string`  | `"user@example.com"`
+| `:hostname`           | `String`                 | `xs:string`       | `string`  | `string`  | `"example.com"`
+| `:ip_v4_address`      | `String`                 | `xs:string`       | `string`  | `string`  | `"192.168.0.1"`
+| `:ip_v6_address`      | `String`                 | `xs:string`       | `string`  | `string`  | `"2001:db8::2:1"`
+| `:token`              | `String`                 | `xs:string`       | `string`  | `string`  | `"label_3.v2"`
+| `:uri_reference`      | `String`                 | `xs:anyURI`       | `string`  | `string`  | `"path/to/resource"`
+| `:uuid`               | `String`                 | `xs:string`       | `string`  | `string`  | `"a3bb189e-8bf9-4888-9912-ace4e6543002"`
+| `:non_negative_integer` | `Integer`              | `xs:nonNegativeInteger` | `number` | `integer` | `7`
+| `:positive_integer`   | `Integer`                | `xs:positiveInteger` | `number` | `integer` | `7`
+| `:date_with_timezone` | `Date`/`DateTime`        | `xs:date`         | `string`  | `string`  | `"2019-12-02-08:00"`
+| `:date_time_with_timezone` | `DateTime`         | `xs:dateTime`     | `string`  | `string`  | `"2019-12-02T16:39:57-08:00"`
+| `:day_time_duration`  | `Lutaml::Model::Type::Duration` | `xs:dayTimeDuration` | `string` | `string` | `"P1DT12H45M"`
+| `:year_month_duration` | `Lutaml::Model::Type::Duration` | `xs:yearMonthDuration` | `string` | `string` | `"P1Y6M"`
 | `:hash`               | `Hash`                   | complex element   | object    | map       | `{key: "value"}`
 | (nil value)           | `nil`                    | `xs:anyType`      | `null`    | `null`    | `null`
 | `{ ref: [Model, :attr] }` | `Reference`          | `xs:string`       | `string`  | `string`  | `"model-id"`
@@ -840,6 +853,53 @@ Every type has a corresponding Ruby class and a serialization format type.
 |===
 
 
+=== NIST Metaschema types
+
+The NIST Metaschema simple data types are supported as first-class value
+types (https://pages.nist.gov/metaschema/specification/datatypes/). Each
+type carries the normative metaschema-datatypes pattern, answers `valid?`
+for a value, and declares it as a restriction facet: attributes typed
+with these types are validated by `model.validate`, and schema
+generation emits the pattern/bounds as restriction facets in every
+supported schema language — `xs:pattern`/`xs:minInclusive` in generated
+XSD, `pattern`/`minimum` plus the NIST `format` keywords (`ipv4`,
+`ipv6`, `email`, `uri-reference`, `duration`, `date`, `date-time`) in
+generated JSON and YAML schemas. Casting follows the lenient
+base-type behavior; TOML has no schema language, so its surface for
+these types is the cast/serialize lane.
+
+.Source types
+[cols="3,4,2"]
+|===
+| Type code        | Metaschema datatype  | Restriction
+
+| `:email_address` | `email-address`      | contains an at-sign
+| `:hostname`      | `hostname`           | non-empty, trimmed
+| `:ip_v4_address` | `ip-v4-address`      | dotted-quad IPv4
+| `:ip_v6_address` | `ip-v6-address`      | RFC3513 IPv6 (incl. zones, embedded IPv4)
+| `:token`         | `token`              | NMTOKEN-like letter/number/punctuation run
+| `:uri_reference` | `uri-reference`      | relative or absolute URI reference
+| `:uuid`          | `uuid`               | RFC4122 UUID, version 4 or 5
+| `:non_negative_integer` | `non-negative-integer` | integer >= 0
+| `:positive_integer` | `positive-integer` | integer >= 1
+| `:date_with_timezone` | `date-with-timezone` | date with `Z` or offset
+| `:date_time_with_timezone` | `date-time-with-timezone` | date-time with `Z` or offset
+| `:day_time_duration` | `day-time-duration` | duration without years/months
+| `:year_month_duration` | `year-month-duration` | duration without time components
+|===
+
+.Usage
+[source,ruby]
+----
+class Asset < Lutaml::Model::Serializable
+  attribute :id, :uuid
+  attribute :owner, :email_address
+  attribute :host, :hostname
+  attribute :address, :ip_v4_address
+  attribute :renewal, :year_month_duration
+end
+----
+
 === Decimal type
 
 The Decimal type uses Ruby's `BigDecimal` for arbitrary-precision decimal

data/docs/_guides/keyvalue-serialization.adoc

@@ -1188,3 +1188,78 @@ In this example:
 `name` attributes, respectively.
 ====
 
+
+== Serialization mapping profiles
+
+A model can declare multiple serialization mappings for the same format —
+*serialization mapping profiles* (also called projections or lenses). Each
+profile is a complete mapping: what it maps is the projection, and
+anything it does not map stays outside it. The base mapping (declared
+without a name) remains the default.
+
+=== Declaring a profile
+
+[source,ruby]
+----
+class Person < Lutaml::Model::Serializable
+  attribute :name, :string
+  attribute :email, :string
+  attribute :internal_id, :string
+
+  json do
+    map "name", to: :name
+    map "email", to: :email
+    map "internal_id", to: :internal_id
+  end
+
+  json :compact do
+    map "name", to: :name
+  end
+end
+----
+
+=== Selecting a profile
+
+Profiles are selected per call with the `mapping:` option, for both
+serialization and parsing. An unknown profile name raises
+`Lutaml::Model::UnknownMappingError`.
+
+[source,ruby]
+----
+person.to_json                       # => {"name"=>"Ed", ...}
+person.to_json(mapping: :compact)    # => {"name"=>"Ed"}
+Person.from_json(json, mapping: :compact)
+----
+
+`only:` and `except:` compose with the selected profile. Child models
+always serialize through their own mappings; a parent's profile does not
+propagate to them.
+
+=== Runtime-constructed mappings
+
+A mapping object can be built at runtime and wired to the model, or used
+directly for a single call. This supports projections that are not known
+at class-definition time.
+
+[source,ruby]
+----
+mapping = Lutaml::Model::Config.mappings_class_for(:yaml).new
+mapping.map "full_name", to: :name
+
+Person.mapping :public, mapping   # register as a named profile
+person.to_yaml(mapping: :public)  # by name
+
+person.to_yaml(mapping: mapping)  # ephemeral, unwired single use
+----
+
+`Person.mapping :name, nil, format: :yaml` removes a registered profile.
+`Person.serialization_mappings(:yaml)` returns the registered profiles of
+a format. Re-declaring or re-registering a name replaces the previous
+mapping.
+
+XML profiles follow the same shape: `xml :registry do ... end` declares a
+profile with its own root element, and `to_xml(mapping: :registry)` /
+`from_xml(data, mapping: :registry)` select it. XSD generation honors
+the selection too: `Lutaml::Model::Schema.to_xsd(Record, mapping:
+:registry)` generates the schema of that projection, leaving unmapped
+attributes outside it.

data/docs/_pages/value_types.adoc

@@ -35,6 +35,19 @@ Every type has a corresponding Ruby class and a serialization format type.
 | `:qname`              | `Lutaml::Model::Type::QName` | `xs:QName`    | `string`  | `string`  | `"prefix:localName"`
 | `:base64_binary`      | `String`                 | `xs:base64Binary` | `string`  | `string`  | `"SGVsbG8gV29ybGQ="`
 | `:hex_binary`         | `String`                 | `xs:hexBinary`    | `string`  | `string`  | `"48656c6c6f"`
+| `:email_address`      | `String`                 | `xs:string`       | `string`  | `string`  | `"user@example.com"`
+| `:hostname`           | `String`                 | `xs:string`       | `string`  | `string`  | `"example.com"`
+| `:ip_v4_address`      | `String`                 | `xs:string`       | `string`  | `string`  | `"192.168.0.1"`
+| `:ip_v6_address`      | `String`                 | `xs:string`       | `string`  | `string`  | `"2001:db8::2:1"`
+| `:token`              | `String`                 | `xs:string`       | `string`  | `string`  | `"label_3.v2"`
+| `:uri_reference`      | `String`                 | `xs:anyURI`       | `string`  | `string`  | `"path/to/resource"`
+| `:uuid`               | `String`                 | `xs:string`       | `string`  | `string`  | `"a3bb189e-8bf9-4888-9912-ace4e6543002"`
+| `:non_negative_integer` | `Integer`              | `xs:nonNegativeInteger` | `number` | `integer` | `7`
+| `:positive_integer`   | `Integer`                | `xs:positiveInteger` | `number` | `integer` | `7`
+| `:date_with_timezone` | `Date`/`DateTime`        | `xs:date`         | `string`  | `string`  | `"2019-12-02-08:00"`
+| `:date_time_with_timezone` | `DateTime`         | `xs:dateTime`     | `string`  | `string`  | `"2019-12-02T16:39:57-08:00"`
+| `:day_time_duration`  | `Lutaml::Model::Type::Duration` | `xs:dayTimeDuration` | `string` | `string` | `"P1DT12H45M"`
+| `:year_month_duration` | `Lutaml::Model::Type::Duration` | `xs:yearMonthDuration` | `string` | `string` | `"P1Y6M"`
 | `:hash`               | `Hash`                   | complex element   | object    | map       | `{key: "value"}`
 | (nil value)           | `nil`                    | `xs:anyType`      | `null`    | `null`    | `null`
 | `{ ref: [Model, :attr] }` | `Reference`          | `xs:string`       | `string`  | `string`  | `"model-id"`
@@ -120,6 +133,56 @@ puts event.start_date.class
 
 
 [[xml-namespace-types]]
+=== NIST Metaschema types
+
+The NIST Metaschema simple data types are supported as first-class value
+types (https://pages.nist.gov/metaschema/specification/datatypes/). Each
+type carries the normative metaschema-datatypes pattern, answers `valid?`
+for a value, and declares it as a restriction facet: attributes typed
+with these types are validated by `model.validate`, and schema
+generation emits the pattern/bounds as restriction facets in every
+supported schema language — `xs:pattern`/`xs:minInclusive` in generated
+XSD, `pattern`/`minimum` plus the NIST `format` keywords (`ipv4`,
+`ipv6`, `email`, `uri-reference`, `duration`, `date`, `date-time`) in
+generated JSON and YAML schemas. Casting follows the lenient
+base-type behavior; TOML has no schema language, so its surface for
+these types is the cast/serialize lane.
+
+.Metaschema type codes and their restrictions
+[cols="3,4,2"]
+|===
+| Type code | Metaschema datatype | Restriction
+
+| `:email_address` | `email-address` | contains an at-sign
+| `:hostname` | `hostname` | non-empty, trimmed
+| `:ip_v4_address` | `ip-v4-address` | dotted-quad IPv4
+| `:ip_v6_address` | `ip-v6-address` | RFC3513 IPv6 (incl. zones, embedded IPv4)
+| `:token` | `token` | NMTOKEN-like letter/number/punctuation run
+| `:uri_reference` | `uri-reference` | relative or absolute URI reference
+| `:uuid` | `uuid` | RFC4122 UUID, version 4 or 5
+| `:non_negative_integer` | `non-negative-integer` | integer >= 0
+| `:positive_integer` | `positive-integer` | integer >= 1
+| `:date_with_timezone` | `date-with-timezone` | date with `Z` or offset
+| `:date_time_with_timezone` | `date-time-with-timezone` | date-time with `Z` or offset
+| `:day_time_duration` | `day-time-duration` | duration without years/months
+| `:year_month_duration` | `year-month-duration` | duration without time components
+|===
+
+.Using metaschema type attributes
+[example]
+====
+[source,ruby]
+----
+class Asset < Lutaml::Model::Serializable
+  attribute :id, :uuid
+  attribute :owner, :email_address
+  attribute :host, :hostname
+  attribute :address, :ip_v4_address
+  attribute :renewal, :year_month_duration
+end
+----
+====
+
 === Additional XSD types
 
 Lutaml::Model supports additional XSD types for specialized data handling:
@@ -1325,6 +1388,45 @@ All built-in types have default XSD type mappings:
 | [`Type::HexBinary`](lib/lutaml/model/type/hex_binary.rb)
 | `xs:hexBinary`
 
+| [`Type::EmailAddress`](lib/lutaml/model/type/email_address.rb)
+| `xs:string`
+
+| [`Type::Hostname`](lib/lutaml/model/type/hostname.rb)
+| `xs:string`
+
+| [`Type::IpV4Address`](lib/lutaml/model/type/ip_v4_address.rb)
+| `xs:string`
+
+| [`Type::IpV6Address`](lib/lutaml/model/type/ip_v6_address.rb)
+| `xs:string`
+
+| [`Type::Token`](lib/lutaml/model/type/token.rb)
+| `xs:string`
+
+| [`Type::UriReference`](lib/lutaml/model/type/uri_reference.rb)
+| `xs:anyURI`
+
+| [`Type::Uuid`](lib/lutaml/model/type/uuid.rb)
+| `xs:string`
+
+| [`Type::NonNegativeInteger`](lib/lutaml/model/type/non_negative_integer.rb)
+| `xs:nonNegativeInteger`
+
+| [`Type::PositiveInteger`](lib/lutaml/model/type/positive_integer.rb)
+| `xs:positiveInteger`
+
+| [`Type::DateWithTimezone`](lib/lutaml/model/type/date_with_timezone.rb)
+| `xs:date`
+
+| [`Type::DateTimeWithTimezone`](lib/lutaml/model/type/date_time_with_timezone.rb)
+| `xs:dateTime`
+
+| [`Type::DayTimeDuration`](lib/lutaml/model/type/day_time_duration.rb)
+| `xs:dayTimeDuration`
+
+| [`Type::YearMonthDuration`](lib/lutaml/model/type/year_month_duration.rb)
+| `xs:yearMonthDuration`
+
 | [`Type::Hash`](lib/lutaml/model/type/hash.rb)
 | `xs:anyType`
 

data/lib/compat/opal/lutaml_model_boot.rb

@@ -281,6 +281,7 @@ require "lutaml/model/error/undefined_attribute_error"
 require "lutaml/model/error/union_schema_unsupported_error"
 require "lutaml/model/error/unknown_adapter_type_error"
 require "lutaml/model/error/unknown_discriminator_error"
+require "lutaml/model/error/unknown_mapping_error"
 require "lutaml/model/error/unknown_sequence_mapping_error"
 require "lutaml/model/error/unknown_type_error"
 require "lutaml/model/error/unresolvable_type_error"
@@ -333,21 +334,35 @@ require "lutaml/model/type/base64_binary"
 require "lutaml/model/type/boolean"
 require "lutaml/model/type/date"
 require "lutaml/model/type/date_time"
+require "lutaml/model/type/date_time_with_timezone"
+require "lutaml/model/type/date_with_timezone"
+require "lutaml/model/type/day_time_duration"
 require "lutaml/model/type/decimal"
 require "lutaml/model/type/duration"
+require "lutaml/model/type/email_address"
 require "lutaml/model/type/float"
 require "lutaml/model/type/hash"
 require "lutaml/model/type/hex_binary"
+require "lutaml/model/type/hostname"
 require "lutaml/model/type/integer"
+require "lutaml/model/type/ip_v4_address"
+require "lutaml/model/type/ip_v6_address"
+require "lutaml/model/type/metaschema_pattern"
+require "lutaml/model/type/non_negative_integer"
+require "lutaml/model/type/positive_integer"
 require "lutaml/model/type/qname"
 require "lutaml/model/type/reference"
 require "lutaml/model/type/string"
 require "lutaml/model/type/symbol"
 require "lutaml/model/type/time"
 require "lutaml/model/type/time_without_date"
+require "lutaml/model/type/token"
 require "lutaml/model/type/uninitialized_class_guard"
 require "lutaml/model/type/uri"
+require "lutaml/model/type/uri_reference"
+require "lutaml/model/type/uuid"
 require "lutaml/model/type/value"
+require "lutaml/model/type/year_month_duration"
 require "lutaml/rdf/namespaces/dcterms_namespace"
 require "lutaml/rdf/namespaces/owl_namespace"
 require "lutaml/rdf/namespaces/rdf_namespace"