metanorma-plugin-lutaml 0.7.12 → 0.7.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0689b02dd3b4eb11afb1e06d187a5426ef392742efe7b01240d031a3178c136c'
-  data.tar.gz: 61c1b2d7010f98036cb33bd7b6935a1ff0368ff2a04a0ecc9849a1a853e60c96
+  metadata.gz: fd66711f9da2a1623acfdb2b6b24d2cea272b6d318cf17dbbdc0167cf69738c2
+  data.tar.gz: 5bd65ea93f25f27e57902389acc574ceb62105ab68a24ab4a44de22e88a9081d
 SHA512:
-  metadata.gz: 2a5852495aac28cfa9c034949fee1a4a5b28eefb1ebe10fdd576cfd4e1fa8a4e1a324b9b4cedc85c6db9a1103cedb2f98c3e649156a1e400a6ce0a441bbefe66
-  data.tar.gz: ca4ec34bebfcc583c22fdeb95504a73dd81fd426768e6b0a0ed22c7f9072344de39e520a94d2c7938be02623cb8ca108b2eafcf1ad77cfdf7195e50a7a4691cd
+  metadata.gz: bc2223f766f4edf63c2cbf69a487306f2575d5448960a56a92f53a5b4fdf712d4c8246ca7bfc48d26b72bec4d054c3266c6eb504f181261490a3cc67770a9c6a
+  data.tar.gz: 681b2571df350dd559241c0047b0a618a083bfc9d52f9b3dc8adf5dc67925b0ab07b9fdf21aa789ae895325edc14adadae2c83c384ad036f2674864e4315b2aa

data/README.adoc

@@ -386,7 +386,28 @@ The command accepts the options listed below:
 
 * `/path/to/example.xmi` specifies the path of xmi file.
 
-* `name="NameOfClass"` specifies the name of the Class.
+* `name` option only, `name` option with `package` option or `path` option.
+  One of 3 forms of options can be used to specify the name of the class.
+
+** `name="NameOfClass"` specifies the name of the `class`.
+   (e.g. `name="Building"`)
+   If there are multiple classes with the same name, other form of options
+   are recommended to specify the class.
+
+** `package="NameOfPackage"name="NameOfClass"` specifies the name of the
+   `class` (specified by `name` option) inside the `package`
+   (specified by `package` option).
+   The `package` option must be used with the `name` option.
+   (e.g. `package="uro",name="_BoundarySurface"`)
+
+** `path="PathOfClass"` specifies the `absolute` path of the `class`
+   which is started with `::`
+   (e.g. `path="::EA_Model::Conceptual Models::i-UR::Urban Planning ADE 3.
+   1::uro::_BoundarySurface"`)
+   or `relative` path of the `class` which is not started with `::`
+   (e.g. `path="uro::_BoundarySurface"`).
+   The last part of the path separated by `::` is the name of the `class`.
+   The other parts of the path are the names of the `packages`.
 
 * `template="/path/to/templates/_my_klass_table.liquid"` specifies the path of
   the liquid template. (Optional)
@@ -394,6 +415,29 @@ The command accepts the options listed below:
   `lib/metanorma/plugin/lutaml/templates`.  This template can be customized by
   changing the template path in the `template` option.
 
+* `guidance="/path/to/my_guidance.yml"` specifies the path of
+  the yaml file of the guidance. (Optional)
+
+The guidance file should be in the following format:
+
+[source,yaml]
+----
+---
+classes:
+  - name: Name Of Class
+    attributes:
+      - name: Name Of Attribute (e.g. gml:boundedBy)
+        used: false
+        guidance: |
+          Drop guidance message here.
+...
+----
+
+If you want to define the guidance, you can define the `name` of the class
+under `classes`.  Then define which `attributes` you want to add guidance by the
+`name`. Set `used` to show the attribute is used or not. Drop the message of
+guidance in `guidance`.
+
 === Generating UML class and attributes: `lutaml_uml_class`
 
 This command allows rendering a definition clause for a UML class.
@@ -853,6 +897,19 @@ By:
 ...
 -----
 
+You can define guidance in the configuration file as well. The configuration
+file will looks like:
+
+[source,yaml]
+-----
+packages:
+  - my_package
+guidance: "path/to/guidance.yaml"
+-----
+
+Please refer to `lutaml_klass_table` section for how to configure the guidance
+yaml file.
+
 == Documentation
 
 Please refer to https://www.metanorma.org.

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

@@ -28,8 +28,16 @@ module Metanorma
             )
           end
 
+          path = if !attrs["path"].nil?
+                   attrs["path"]
+                 elsif !attrs["package"].nil? && !attrs["name"].nil?
+                   "#{attrs['package']}::#{attrs['name']}"
+                 else
+                   attrs["name"]
+                 end
+
           klass = ::Lutaml::XMI::Parsers::XML.serialize_generalization_by_name(
-            xmi_path, attrs["name"], attrs["guidance"]
+            xmi_path, path, attrs["guidance"]
           )
 
           render(klass, parent, attrs)

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.12".freeze
+      VERSION = "0.7.14".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.12
+  version: 0.7.14
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor