metanorma-plugin-lutaml 0.7.58 → 0.7.59

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c90313afe5e40c1be36f364ea036e92e6f900631d118e2ea9153296b92adbfe2
-  data.tar.gz: 0af70233ce559776a23fae4ffbd21147ceaab1daf60380f8ed576a5bb5a94aa7
+  metadata.gz: d96f09e7d7f1d19bbe312762e74ee2202906df8d101844b4f886cddf13a03835
+  data.tar.gz: 3e58ee7adb78b9f8fe376c8903802e7ccba16649ad569b981b67670f2bd46c36
 SHA512:
-  metadata.gz: 288872689df43058c47cbfbe4eebf53343fe60b9030e25e26ca960353c727d90557790fec5beb45da7ed0fa7691bd195905ceac0209897237fa31cf005a70a03
-  data.tar.gz: 953d776b5c798164079a7159e325b921a78361450c0c690a6311fa66f9f34ad75b6ffe7df1bbb884326a3184029d6fc25619b96149ad4ae10f6e11f589a9bf34
+  metadata.gz: f25f543755e3a342f1cd640b2413a1bcaef5b5a9ab7706d71c4786f35814d76e0aa9c37f03b381a381420be714bf190f5fde568cb5d725f357448670a3b7b81b
+  data.tar.gz: 646d8ddf3d4e5823a9a2740a8193d2e3109273587b33ffed2e02e338182e82241fc26e7b94dcc192922830b6d1ff8f3637eaec99564c4a4d422d3762ce6cb741

data/.github/workflows/rake.yml

@@ -17,10 +17,6 @@ jobs:
   rake:
     uses: metanorma/ci/.github/workflows/generic-rake.yml@v1
     with:
-      # svg_conform 0.2.5 was re-pushed with corrected metadata; the
-      # compact-index line cached in ~/.bundle still carries the old
-      # (lens_core) record and fails every install against it.
-      before-setup-ruby: rm -rf ~/.bundle/cache/compact_index vendor/bundle/cache && mkdir -p vendor/bundle/cache && curl -sfL https://rubygems.org/gems/svg_conform-0.2.5.gem -o vendor/bundle/cache/svg_conform-0.2.5.gem
       setup-tools: graphviz
       submodules: true
       choco-cache: true

data/Gemfile

@@ -42,4 +42,4 @@ gem "metanorma-document", github: "metanorma/metanorma-document", branch: "main"
 # re-pushed build carries a lens_core dependency that is not published);
 # 0.2.4 is the last clean release and rides moxml ~> 0.5 (= satisfied by
 # the 0.6 line). Lift when a clean 0.2.6 ships.
-gem "svg_conform", "0.2.4"
+gem "svg_conform", "~> 0.2.6"

data/README.adoc

@@ -39,6 +39,8 @@ link:docs/usages/lutaml-gml.adoc[Usage with LutaML GML Dictionary by lutaml_gml_
 
 link:docs/usages/json_yaml.adoc[Usage with JSON or YAML files by data2text, yaml2text or json2text]
 
+link:docs/usages/lutaml-data.adoc[Usage with LutaML data files by lutaml_data]
+
 link:docs/usages/lutaml-xsd.adoc[Usage with XML Schema files by lutaml_xsd]
 
 == Documentation

data/docs/usages/lutaml-data.adoc

@@ -0,0 +1,227 @@
+== Usage with LutaML data files by lutaml_data
+
+=== General
+
+The `lutaml_data` block command loads data that is defined with LutaML models
+and makes it available to a Liquid template in the block.
+
+The data consists of two parts:
+
+* the *data definitions*: LutaML models, always written in a `.lml` file; and
+* the *data instances*: values of those models, written in `.lml`, `.yaml`,
+  `.yml` or `.json`.
+
+=== Defining a block
+
+Data definitions and data instances in separate files:
+
+[source,asciidoc]
+------
+[lutaml_data,{definition_file},{instance_file},{context_name},options={...}]
+----
+...Liquid template...
+----
+------
+
+Data definitions and data instances in the same `.lml` file:
+
+[source,asciidoc]
+------
+[lutaml_data,{definition_file},{context_name},options={...}]
+----
+...Liquid template...
+----
+------
+
+`definition_file`:: (required) Path to the `.lml` file that holds the LutaML
+models. Relative paths are resolved from the directory of the Metanorma
+document. When this is the only file given, the same file must also contain
+the instances.
+
+`instance_file`:: (optional) Path to the file that holds the data instances,
+with extension `.lml`, `.yaml`, `.yml` or `.json`. The `.lml` instance file
+usually starts with `require "<definition_file>"`.
+
+`context_name`:: (optional) The name under which the data is exposed to the
+Liquid template. Defaults to `lutaml_data`.
+
+`options`:: (optional) Rendering options, given either as a JSON object
+(`options={"include_path":"templates"}`) or as inline `key=value` pairs
+(`include_path=templates`). The supported option is `include_path`, a
+comma-separated list of directories searched by the Liquid `include` tag.
+
+NOTE: A segment is taken as the instance file when its extension is one of
+`.lml`, `.yaml`, `.yml` or `.json`; any other segment is taken as the context
+name.
+
+=== Data in the Liquid context
+
+The data is exposed under `context_name`, then the name of the instance.
+
+* For `.lml` instances, the key is the instance name (`instance S158Checks { ... }`
+  is `S158Checks`).
+* For `.yaml` and `.json` instances, the key is the model name given by the
+  required `type` entry (`type: Widgets` is `Widgets`). A file may hold one
+  object or a list of objects.
+
+Attributes are read by name (`check.dev_id`), collections are iterated with
+`for`, and enum values expose the attributes defined in the model
+(`check.classification.description`).
+
+=== Example
+
+Data definitions, `s102_models.lml`:
+
+[source]
+----
+models IhoS102Check {
+  enum CheckClassification {
+    critical_error {
+      description "Critical Error"
+    }
+    warning {
+      description "Warning"
+    }
+  }
+
+  class ValidationChecks {
+    attribute checks {
+      type ValidationCheck
+      cardinality 0..n
+    }
+  }
+
+  class ValidationCheck {
+    attribute dev_id {
+      type String
+      cardinality 1
+    }
+
+    attribute classification {
+      type CheckClassification
+      cardinality 1
+    }
+
+    attribute check_message {
+      type String
+      cardinality 1
+    }
+  }
+}
+----
+
+Data instances, `s102_checks.lml`:
+
+[source]
+----
+// s102_checks.lml
+require "s102_models.lml"
+instance S158Checks {
+  type ValidationChecks
+
+  checks = [
+    instance IhoS102Check::ValidationCheck {
+      dev_id = "S102_Dev1001"
+      classification = CheckClassification::critical_error
+      check_message = "No feature information group"
+    },
+
+    instance IhoS102Check::ValidationCheck {
+      dev_id = "S102_Dev1002"
+      classification = CheckClassification::warning
+      check_message = "Mandatory metadata attribute missing"
+    }
+  ]
+}
+----
+
+NOTE: In `.lml` files, comments start with `//`. A `#` comment is rejected by
+the instance parser.
+
+The Metanorma document:
+
+[source,asciidoc]
+------
+[lutaml_data,s102_models.lml,s102_checks.lml,lml]
+----
+{% for check in lml.S158Checks.checks %}
+=== S-102 Validation Check `{{ check.dev_id }}`
+
+classification: {{ check.classification.description }}
+
+check message: {{ check.check_message }}
+
+{% endfor %}
+----
+------
+
+renders as:
+
+[source,asciidoc]
+----
+=== S-102 Validation Check `S102_Dev1001`
+
+classification: Critical Error
+
+check message: No feature information group
+
+=== S-102 Validation Check `S102_Dev1002`
+
+classification: Warning
+
+check message: Mandatory metadata attribute missing
+----
+
+=== Instances in YAML or JSON
+
+The same data can be given as YAML (`s102_checks.yaml`):
+
+[source,yaml]
+----
+type: ValidationChecks
+checks:
+  - dev_id: S102_Dev1001
+    check_message: No feature information group
+----
+
+NOTE: Enum-typed attributes (such as `classification` above) cannot currently
+be set from YAML or JSON instances; loading fails. Use `.lml` instances for
+data that has enum values.
+
+The key in the template is the type name:
+
+[source,asciidoc]
+------
+[lutaml_data,s102_models.lml,s102_checks.yaml,lml]
+----
+{% for check in lml.ValidationChecks.checks %}
+{{ check.dev_id }}
+{% endfor %}
+----
+------
+
+=== Instances in the definition file
+
+If the instances are in the definition file, omit the instance file:
+
+[source,asciidoc]
+------
+[lutaml_data,widgets.lml,store]
+----
+{% for widget in store.AllWidgets.widgets %}
+{{ widget.id }}: {{ widget.name }}
+{% endfor %}
+----
+------
+
+=== Options
+
+Directories for Liquid `include` can be set with `options`:
+
+[source,asciidoc]
+------
+[lutaml_data,widgets.lml,store,options={"include_path":"templates"}]
+----
+{% include 'heading' %}
+----
+------

data/lib/metanorma/plugin/lutaml/express_remark_adapter.rb

@@ -17,22 +17,19 @@ module Metanorma
           )
           resolved = document.path_resolver
             .system_path(file_path, docfile_directory)
-          # The decorator expands emitted paths against this base: relative
-          # prefixes alone get re-anchored by asciidoctor's imagesdir
-          # handling (images/../../schemas collapses a level), so the
-          # decoration must produce paths that resolve from the docfile.
-          options["relative_path_base"] =
-            File.expand_path(docfile_directory)
           # The prefix lands inside emitted image macros, so it must not
           # carry the absolute build path: two builds of the same tree in
           # two directories produced different image/@src values
           # (metanorma/metanorma-plugin-lutaml#325). A path relative to the
           # docfile resolves to the same schema file at render time and is
-          # byte-identical across build directories.
+          # byte-identical across build directories; the decorator joins it
+          # as written rather than expanding it.
           # The docfile directory may be relative ("."): relative_path_from
           # refuses mixed prefixes, so both sides expand first
           Pathname.new(File.expand_path(resolved))
-            .relative_path_from(Pathname.new(File.expand_path(docfile_directory)))
+            .relative_path_from(
+              Pathname.new(File.expand_path(docfile_directory)),
+            )
             .to_s
         end
 

data/lib/metanorma/plugin/lutaml/express_remarks_decorator.rb

@@ -68,19 +68,15 @@ module Metanorma
           return line if path_prefix && line.include?(path_prefix)
 
           line.gsub(RELATIVE_PREFIX_MACRO_REGEXP) do |_match|
-            # Expand against the docfile directory (passed by the adapter
-            # as relative_path_base), NOT the process CWD: a CWD expansion
-            # produced absolute image paths under whatever directory the
-            # build was launched from (e.g. <repo>/../../schemas/...).
-            # The absolute result is deliberate: relative targets are
-            # re-anchored by asciidoctor's imagesdir handling
-            # (images/../../schemas collapses a level), which made every
-            # decorated diagram unresolvable at render time.
-            full_path = File.expand_path(
-              File.join(path_prefix, $3.strip),
-              options["relative_path_base"] || Dir.pwd,
-            )
-            "#{$1}#{$2}#{full_path}#{$4}"
+            # The prefix is already docfile-relative (see
+            # ExpressRemarkAdapter.relative_path_prefix), so joining it
+            # keeps the emitted path relative to the docfile too. Expanding
+            # to an absolute path embedded the build directory in the
+            # output, making semantic XML, presentation XML and HTML differ
+            # between two builds of the same tree (#325). Resolution is the
+            # renderer's job: a relative target joined with imagesdir still
+            # resolves against the docfile at render time.
+            "#{$1}#{$2}#{File.join(path_prefix, $3.strip)}#{$4}"
           end
         end
       end

data/lib/metanorma/plugin/lutaml/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.58".freeze
+      VERSION = "0.7.59".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.58
+  version: 0.7.59
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-11-01 00:00:00.000000000 Z
+date: 2026-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -187,6 +187,7 @@ files:
 - docs/usages/enterprise_architect_uml.adoc
 - docs/usages/express.adoc
 - docs/usages/json_yaml.adoc
+- docs/usages/lutaml-data.adoc
 - docs/usages/lutaml-gml.adoc
 - docs/usages/lutaml-uml.adoc
 - docs/usages/lutaml-xsd.adoc