metanorma-plugin-lutaml 0.7.11 → 0.7.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0601a4c6b35e5d1fd1c58d24240e3a5dea1b87bae62cbf9ce17ac904c21d5bf
-  data.tar.gz: 60d05d99810e378da5df64b8ec603fbf522a3e66c10ef9ef776c0c616dd2a9e0
+  metadata.gz: 0270f7d18a587b6569572dc7dc21fffe4e10939e32fe8ffcfa8e86888e1e772d
+  data.tar.gz: e1a826c03cbb78311eff5143b7ca41b9ce7e4a0ae0c55afd1fb31682ccec02b4
 SHA512:
-  metadata.gz: 1a6e74aa665b6b3917ce08bc0a8aa7464dd3acb3fa6e1664f0a4e9951c3a204769299d8fbe3ff3be3f9b700b9d3cf28def826844cb0fa6de94fc6158827eb011
-  data.tar.gz: e772698bfc26cbb86bf58e171dcd2e531c91b834f67b7241939ee9db2cf51516d8531c46ae69eae14148c46575c85fe94e02502b73b0d78e2c3ff8bc2546d6fa
+  metadata.gz: 12e9e15833fa38b735f7caae2c3e6686c65e42872a38303a866268d74510e16d7a2296107c146f539dff5b6183c65fc35e5bdbca460736594c2653edd7c2abe3
+  data.tar.gz: b09e732cdde35ab5da7638245480647fe543394509ed416fe8a9d09a2e3fec12620395210975b39428d7b986ad0268f45f7c6dfbe2a33b1d39cee990b052588f

data/README.adoc

@@ -394,6 +394,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 +876,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/liquid_templates/_klass_table.liquid

@@ -1,11 +1,23 @@
 {% assign root = klass.generalization %}
+
+{%- capture upper_klass_name -%}
+{{ root.general.upper_klass }}:{{ root.general.name }}
+{%- endcapture -%}
+{%- if upper_klass_name == ":" -%}
+  {%- assign upper_klass_name = "-" -%}
+{%- endif -%}
+{%- capture stereotype -%}<< {{ root.stereotype }} >>{%- endcapture -%}
+{%- if stereotype == "<<  >>" -%}
+  {%- assign stereotype = " " -%}
+{%- endif -%}
+
 [cols="1a,1a,2a"]
 |===
 | Definition of Type
 2+| {{ root.definition }}
 
-h| Upper Type 2+| {{ root.general.upper_klass }}:{{ root.general.name }}
-h| Stereotype 2+| << {{ root.stereotype }} >>
+h| Upper Type 2+| {{ upper_klass_name }}
+h| Stereotype 2+| {{ stereotype }}
 
 3+h| Inherited Properties
 h| Property Name h| Property Type and Multiplicity h| Definition
@@ -16,7 +28,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}
@@ -30,7 +42,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}
@@ -44,7 +56,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}
@@ -58,7 +70,7 @@ h| Property Name h| Property Type and Multiplicity h| Definition
       ({{ attr.gen_name }})
     {%- endcapture -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
     | {{ attr.definition }}
   {%- endif -%}
 {% endfor %}

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

@@ -55,12 +55,24 @@ module Metanorma
             Xmi::EaRoot.load_extension(ea_extension_full_path)
           end
 
-          result_document = parse_result_document(full_path)
+          guidance = get_guidance_file(document, yaml_config["guidance"])
+          result_document = parse_result_document(full_path, guidance)
           document.attributes["lutaml_xmi_cache"] ||= {}
           document.attributes["lutaml_xmi_cache"][full_path] = result_document
           result_document
         end
 
+        def get_guidance_file(document, guidance_config)
+          guidance = nil
+
+          if guidance_config
+            guidance = Utils.relative_file_path(document,
+                                                guidance_config)
+          end
+
+          guidance
+        end
+
         def parse_yaml_config_file(document, file_path)
           return {} if file_path.nil?
 

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

@@ -24,9 +24,10 @@ module Metanorma
 
         private
 
-        def parse_result_document(full_path)
+        def parse_result_document(full_path, guidance)
           ::Lutaml::XMI::Parsers::XML.serialize_xmi_to_liquid(
             File.new(full_path, encoding: "UTF-8"),
+            guidance,
           )
         end
       end

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

@@ -22,8 +22,14 @@ module Metanorma
             )
           end
 
+          if attrs["guidance"]
+            attrs["guidance"] = Utils.relative_file_path(
+              parent.document, attrs["guidance"]
+            )
+          end
+
           klass = ::Lutaml::XMI::Parsers::XML.serialize_generalization_by_name(
-            xmi_path, attrs["name"]
+            xmi_path, attrs["name"], attrs["guidance"]
           )
 
           render(klass, parent, attrs)

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

@@ -24,7 +24,7 @@ module Metanorma
 
         private
 
-        def parse_result_document(full_path)
+        def parse_result_document(full_path, _guidance = nil)
           ::Lutaml::Parser.parse(File.new(full_path, encoding: "UTF-8")).first
         end
       end

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

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

data/metanorma-plugin-lutaml.gemspec

@@ -29,14 +29,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "coradoc", "~> 1.1.1"
   spec.add_dependency "expressir", "~> 1.4.0"
   spec.add_dependency "liquid"
-  spec.add_dependency "lutaml", ">= 0.9.14"
-  spec.add_dependency "ogc-gml"
+  spec.add_dependency "lutaml", ">= 0.9.18"
+  spec.add_dependency "ogc-gml", "1.0.0"
   spec.add_dependency "relaton-cli"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml"
   spec.add_development_dependency "metanorma-standoc"
-  spec.add_development_dependency "ogc-gml"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rspec-html-matchers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.11
+  version: 0.7.13
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.14
+        version: 0.9.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.14
+        version: 0.9.18
 - !ruby/object:Gem::Dependency
   name: ogc-gml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: relaton-cli
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ogc-gml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement