lutaml 0.11.3 → 0.11.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b816c810e9f0dcc23cd37af5a3520d3f3743710501e4ad4924fd5c9ab5dcf286
-  data.tar.gz: 585f1009c6d073c5173a9559c4f9ae96f6aeb5ebf8f03d8f7a211c330cac9d4a
+  metadata.gz: 0f34bf66cbe8f9fa2f898f3c5afcdf099ed1603883445cb07a42887e0d8c7e35
+  data.tar.gz: 7f32c3792d828d9c5303c30395e80f0a45e0d7da13b2e095b8aeed93052ab1b0
 SHA512:
-  metadata.gz: c8f7eba7c819f9098c2b722828472c679fd2365068e1d1ea3e418c76ff88c3f028cd933c2f9663fe567c4b8438feafdbdb78de69a9d7a40cba2a0b7658939887
-  data.tar.gz: bb4992e75e8c26ad47b1adcc11015bf4f3e08b584815b30c0d341a83dbc547d371b7559aacc3c3c4bdd15f75fe09dba8cce8731f4684f327ed09bdd0b8c01cec
+  metadata.gz: 923866c877f40ab1937d57c075c7c8a212998a128cd6438ab25688041990a37f8bf06ff532c8615e08360ef71570de746127142fb239c0cc697d57a09cdb7b1a
+  data.tar.gz: 77586b69cc36d6ecb67c2ee83a04671bf4fdc0e467594b92aaede202da308c9a8f4fadc5b28ccb6caa4d95a8d0e764bfed5fda91d19423cfe9b8163825ba8650

data/.github/workflows/release.yml

@@ -4,7 +4,6 @@ name: release
 
 permissions:
   contents: write
-  packages: write
   id-token: write
 
 on:
@@ -12,24 +11,27 @@ on:
     inputs:
       next_version:
         description: |
-          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
-          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'skip'
-      acknowledge_breaking_in_patch:
-        description: "Skip the release-breaking-check guard"
-        required: false
-        default: "true"
   repository_dispatch:
     types: [ do-release ]
 
+# One release at a time: concurrent bumps race the version commit
+# and half-published gems are worse than a queued release.
+concurrency:
+  group: release
+  cancel-in-progress: false
+
 jobs:
   release:
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
-      acknowledge_breaking_in_patch: ${{ github.event.inputs.acknowledge_breaking_in_patch == 'true' }}
-      gated: false
     secrets:
-      rubygems-api-key: ${{ secrets.LUTAML_CI_RUBYGEMS_API_KEY }}
-      pat_token: ${{ secrets.GITHUB_TOKEN }}
+      # OMIT rubygems-api-key: metanorma/ci switches to OIDC Trusted Publishing
+      # when the secret is empty (USE_OIDC = rubygems-api-key == ''). Trusted
+      # Publishing is already configured for the lutaml gems on rubygems.org.
+      # The removed `gated` input no longer exists in the reusable workflow
+      # and made every dispatch fail at startup.
+      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}

data/README.adoc

@@ -51,56 +51,19 @@ bundle exec jekyll serve
 
 === Parsing
 
-The `Lutaml::Parser.parse` method provides a single point of entry for parsing
-data model files, including:
-
-* EXPRESS files with `.exp` extension
-* YAML Compressed EXPRESS CACHE files
-* QEA files with `.qea` extension (Enterprise Architect databases)
-* XMI files with `.xmi` extension
-* XML files with `.xml` extension
-* LutaML files with `.lutaml` extension
-
-Depending on the input file type, `Lutaml::Parser.parse` returns:
-
-* `Expressir::Express::Model::Repository` for EXPRESS files
-* `Expressir::Express::Cache` for EXPRESS CACHE files
-* `Lutaml::Uml::Document` for QEA files (returned as single-element array)
-* `Lutaml::Uml::Document` for XMI files
-* `Lutaml::Uml::Document` for XML files
-* `Lutaml::Uml::Document` for LutaML files
-
-Examples to use the `Lutaml::Parser.parse`:
+Parse LutaML Model Language (`.lml`/`.lutaml`) files with
+link:https://github.com/lutaml/lutaml-lml[lutaml-lml]:
 
 [source,ruby]
 ----
 require "lutaml"
 
-# example.exp is an EXPRESS schema file
-model = Lutaml::Parser.parse([File.new("example.exp")])
-# => returns Expressir::Express::Model::Repository model
-
-# example.exp.yaml is an EXPRESS cache file created with Expressir
-model = Lutaml::Parser.parse([File.new("example.exp.yaml")], ::Lutaml::Parser::EXPRESS_CACHE_PARSE_TYPE)
-# => returns Expressir::Express::Cache model
-
-# example.xmi is an XMI file
-model = Lutaml::Parser.parse([File.new("example.xmi")])
-# => returns Lutaml::Uml::Document model
-
-# example.xml is an XML file
-model = Lutaml::Parser.parse([File.new("example.xml")])
-# => returns Lutaml::Uml::Document model
-
-# example.lutaml is an LutaML file
-model = Lutaml::Parser.parse([File.new("example.lutaml")])
-# => returns Lutaml::Uml::Document model
-
-# example.yaml is an LutaML YAML file
-model = Lutaml::Parser.parse([File.new("example.yaml")])
-# => returns Lutaml::Uml::Document model
+doc = Lutaml::Lml.parse_document(File.new("model.lutaml"))
+doc.classes.first.attributes.map(&:name)
 ----
 
+EXPRESS schemas parse through `Lutaml::Express::Parsers::Exp.parse(io)`;
+see README.md for the full family table and the repository layer.
 
 == Working with UML
 

data/README.md

@@ -0,0 +1,49 @@
+# LutaML
+
+LutaML is data models in textual form. The `lutaml` gem is the umbrella
+of the LutaML family: it installs the core engine together with the
+textual modelling languages built on top of it, and exposes the EXPRESS
+parsing surface under the `Lutaml::Express` namespace.
+
+## The LutaML family
+
+| Gem | Role |
+| --- | --- |
+| [lutaml-model](https://github.com/lutaml/lutaml-model) | Core declarative data modelling engine with serialization to and from XML, JSON, YAML, TOML and Hash. |
+| [lutaml-lml](https://github.com/lutaml/lutaml-lml) | Parser and converter for the LutaML Model Language (LML, `.lml`/`.lutaml`) textual syntax. |
+| [lutaml-uml](https://github.com/lutaml/lutaml-uml) | UML domain models, document repository (`.lur` packages), and static-site generation. |
+| [expressir](https://github.com/lutaml/expressir) | EXPRESS language parser and repository tooling. |
+| **lutaml** (this gem) | Umbrella for the family; EXPRESS schema parsing through `Lutaml::Express::Parsers::Exp`. |
+
+The wider ecosystem installs separately as needed:
+[lutaml-store](https://github.com/lutaml/lutaml-store) (document store),
+[lutaml-hal](https://github.com/lutaml/lutaml-hal) (HAL documents),
+[lutaml-jsonschema](https://github.com/lutaml/lutaml-jsonschema) (JSON
+Schema generation), [lutaml-xmi](https://github.com/lutaml/lutaml-xmi)
+(XMI import), and [lutaml-path](https://github.com/lutaml/lutaml-path)
+(path queries over LutaML models).
+
+## Installation
+
+```ruby
+gem "lutaml"
+```
+
+## Usage
+
+```ruby
+require "lutaml"
+
+repository = File.open("schema.exp") do |io|
+  Lutaml::Express::Parsers::Exp.parse(io)
+end
+```
+
+Requiring `lutaml` loads `lutaml-lml`, `lutaml-uml` (including its
+repository layer) and the EXPRESS parser autoload; every member of the
+family builds on `lutaml-model`.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/docs/_guides/uml-modeling.adoc

@@ -104,12 +104,10 @@ The following results will be produced:
 [source,lutaml]
 ----
 diagram Address {
-  title ''
-  caption ''
   association {
     owner_type aggregation
-    owner
-    member_type direct
+    owner Address
+    member_type association
     member AddressComponent
   }
 }

data/docs/_pages/uml-syntax.adoc

@@ -152,7 +152,7 @@ If this syntax is used inside a `class`/`enum`/`association` block, it will be c
   This is a
   multi-line
   document comment.
-*|
+|*
 
 class A
 enum B {
@@ -162,7 +162,7 @@ enum B {
     This is a
     multi-line
     class comment.
-  *|
+  |*
   bar
 }
 ----
@@ -279,15 +279,22 @@ following:
 
 The name of the element and its visibility are optional.
 
+[NOTE]
+--
+Visibility on package contents (classes, enums, packages) is not yet
+implemented; only attribute visibility (`+`, `-`, `#`, `~`) is parsed
+today. Element-level visibility is a candidate for adoption into the
+LML specification (RS 3001) pending an audit of UML round-trip
+requirements.
+--
+
 [example]
-.Declaring a package named "Ceramic" with a public visibility modifier
+.Declaring a package named "CeramicInformationModel"
 ====
 [source]
 ----
 package CeramicInformationModel {
   class Ceramic {}
-  - class PrivateCeramic {}
-  # class ProtectedCeramic {}
 }
 ----
 ====
@@ -584,7 +591,7 @@ Explicit syntax (`attribute` keyword included):
 [source]
 ----
 class A {
-  attribute my_attribute
+  attribute my_attribute, String
 }
 
 enum A {
@@ -670,6 +677,14 @@ class Figure {
 
 === Methods
 
+[NOTE]
+--
+Methods are not yet implemented by the LML parser. This section
+documents the planned surface; adoption into the LML specification
+(RS 3001) is pending an audit of downstream UML round-trip
+requirements (Enterprise Architect, XMI).
+--
+
 ==== General
 
 A method is a function that is defined inside a class and can be called to
@@ -881,8 +896,14 @@ association {
 ====
 [source]
 ----
+class Ceramic {}
+class Glaze {}
+
 association {
-  Ceramic -> Glaze
+  owner_type association
+  owner Ceramic
+  member_type association
+  member Glaze
 }
 ----
 ====
@@ -893,37 +914,32 @@ Syntax:
 
 [source]
 ----
-association name {
-  owned_type association|composition|aggregation|generalization|uses
+association [name] {
+  owner_type association|composition|aggregation|generalization|uses
+  owner class_name[#attribute_name]
   member_type association|composition|aggregation|generalization|uses
-  owned association_name[#attribute_name] [{property_string}][cardinality]
-  member association_name[#attribute_name] [{property_string}][cardinality]
+  member class_name[#attribute_name]
 }
 ----
 
 where:
 
-* `owned_type` - optional, use to define a bidirectional association (`association`|`composition`|`aggregation`|`generalization`|`uses`)
+* `owner_type` - optional, use to define a bidirectional association (`association`|`composition`|`aggregation`|`generalization`|`uses`)
 * `member_type` - association type (`association`|`composition`|`aggregation`|`generalization`|`uses`)
-* `owned|member` - end of association, use `\#attribute_name` to set a role name
-* `property_string` - property string for attributes associations
-* `cardinality` - examples: `1..*`, `*`
+* `owner`/`member` - end of association, use `#attribute_name` to set a role name
 
 Example:
 
 [source]
 ----
-class Association {
-  +association:
-}
-class Type {
-  +endType:
-}
+class Address {}
+class AddressComponent {}
 
-association AssociatingTypeAndAssociation {
-  type uses
-  from Association#+association {subsets relationship}[*]
-  to Type#+/endType {readOnly, subsets relatedElement} [1..*]
+association AddressesAssociation {
+  owner_type aggregation
+  owner Address
+  member_type association
+  member AddressComponent
 }
 ----
 

data/lib/lutaml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lutaml
-  VERSION = "0.11.3"
+  VERSION = "0.11.5"
 end

data/lutaml.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   # (fiddle was removed from Ruby 4.0 default gems, breaking reline on Windows)
   spec.add_dependency "fiddle"
   spec.add_dependency "lutaml-lml"
-  spec.add_dependency "lutaml-uml", "~> 0.5" # pin: 1.0.0 depends on lutaml (circular)
+  spec.add_dependency "lutaml-model", "~> 0.8.114"
+  spec.add_dependency "lutaml-uml", "~> 1.0"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lutaml
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.11.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-08 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir
@@ -52,20 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.114
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.114
 - !ruby/object:Gem::Dependency
   name: lutaml-uml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 description: 'LutaML: data models in textual form'
 email:
 - open.source@ribose.com
@@ -86,6 +100,7 @@ files:
 - CLAUDE.md
 - Gemfile
 - README.adoc
+- README.md
 - Rakefile
 - bin/console
 - bin/folder_yaml2lutaml.sh