metanorma-plugin-lutaml 0.7.13 → 0.7.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0270f7d18a587b6569572dc7dc21fffe4e10939e32fe8ffcfa8e86888e1e772d
-  data.tar.gz: e1a826c03cbb78311eff5143b7ca41b9ce7e4a0ae0c55afd1fb31682ccec02b4
+  metadata.gz: '084aa029d93896c415377c7d2cf97cbc449c4105e838496cc8d598ecf3aa9a5f'
+  data.tar.gz: 50347ca8bb82cb0cf10a3c07eb2df5386180395948b06dd7a266bcd50565bb93
 SHA512:
-  metadata.gz: 12e9e15833fa38b735f7caae2c3e6686c65e42872a38303a866268d74510e16d7a2296107c146f539dff5b6183c65fc35e5bdbca460736594c2653edd7c2abe3
-  data.tar.gz: b09e732cdde35ab5da7638245480647fe543394509ed416fe8a9d09a2e3fec12620395210975b39428d7b986ad0268f45f7c6dfbe2a33b1d39cee990b052588f
+  metadata.gz: 5298953ac429e585eab80983840e541f83be422e7ffec84c8c4dd398aba5a3e0534146e775088e9dcf6659ef3747718953a95d25b37b3b76ae50ad2ea971057f
+  data.tar.gz: 6533e3763431b164961944be151092bec140137d244b8fad2664d59aec2854d8bc955bb733c1a439eddb3450aa239aff9d5bfdfa02814b34f15ce920a304dd35

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,7 +415,7 @@ 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
+* `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:
@@ -886,8 +907,36 @@ packages:
 guidance: "path/to/guidance.yaml"
 -----
 
-Please refer to `lutaml_klass_table` section for how to configure the guidance
-yaml file.
+The guidance file should be in the following format:
+
+[source,yaml]
+----
+---
+classes:
+  - name: "NameOfClass"
+    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`.
+
+The `name` of class can be defined in the following ways:
+
+* `name: "NameOfClass"` specifies the name of the `class`.
+  (e.g. `name: "Building"`)
+  If there are multiple classes with the same name, it is recommended to
+  specify the class by absolute path.
+
+* `name: "::NameOfPackage::NameOfClass"` specifies the name of the `class` in
+  `absolute` path.
+  (e.g. `name: "::EA_Model::Conceptual Models::CityGML2.0::bldg::Building"`)
 
 == Documentation
 

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.13".freeze
+      VERSION = "0.7.15".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.13
+  version: 0.7.15
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor