metanorma-plugin-lutaml 0.7.9 → 0.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29510e3dd02119b47d1d179c94d0a954b596dc0255410091d8c0db366e6a4dd3
-  data.tar.gz: b2502ffd6bea597bc56c8882712c58d13e72799eca5387c76329a9ef813d62eb
+  metadata.gz: 4a8884a3a005d1987c9403af11f7dddb62657e28178881e7ef848383280edfcb
+  data.tar.gz: 210ca361b8facc4702196a1f2f734e79abe0b325e30db269c991884c0cbc2714
 SHA512:
-  metadata.gz: b06a2f0d8be8e9073c3f631b260d8e88525353afb8e4e6cdf11bd6db9d78994543eb6a9acda9a2602212943ff972a700efa7c7d3dc870951cd3f2c6e5a219ff2
-  data.tar.gz: c80c2d456bec408dccb3c621397bc9313e2cc6a53cf7c5671d504737087ebb597b446d2fc043e3deaaf809a0941f0f3b732837bf4b5aee404685d70cd6ab0d27
+  metadata.gz: ab318c1c9a6bf060093600533ff59c6b293c70a90c3096ec5ab88100546e2ae2a18d0e52f8571bdf72d1da14df0fd6fdbfbc7a8cf3c9716ba34a2f154a4e5f64
+  data.tar.gz: 0e3acb93421b591442d0293c08c5fb9b2e8e8c1f4925eb5f9f0fbbb77997b5cbc80e8e30cce5dd4accc4b1fe40d91c2ebce09e7f17db901ad8afbb82b8d0cb37

data/README.adoc

@@ -315,7 +315,7 @@ lutaml_gml_dictionary::/path/to/dictionary.xml[template="/path/to/template.liqui
 
 The command accepts the options listed below:
 
-* `"/path/to/dictionary.xml` specifies the path of xml file of the
+* `/path/to/dictionary.xml` specifies the path of xml file of the
 GML Dictionary.
 
 * `template="/path/to/template.liquid"` specifies the liquid template.
@@ -364,6 +364,36 @@ h| Help | Description
 --
 -----
 
+=== Rendering a LutaML table of a class: `lutaml_klass_table`
+
+This command allows to render a LutaML table of a class by using Liquid Drop.
+
+The table will show:
+
+* Class Name
+* Class Definition
+* Inherited Properties
+* Self-defined Properties
+* Properties Inherited from Association
+* Properties Defined in Association
+
+[source,adoc]
+-----
+lutaml_klass_table::/path/to/example.xmi[name="NameOfClass",tmpl_folder="/path/to/templates"]
+-----
+
+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.
+
+* `tmpl_folder="/path/to/templates"` specifies the folder path of the templates.
+  (Optional)  By default, it will look for the templates `_klass_table.liquid`,
+  `_klass_row.liquid` and `_klass_assoc_row.liquid` defined in
+  `lib/metanorma/plugin/lutaml/templates`.  These templates can be customized by
+  defining them in `/path/to/templates` and then set the `tmpl_folder` option.
+
 === Generating UML class and attributes: `lutaml_uml_class`
 
 This command allows rendering a definition clause for a UML class.
@@ -796,6 +826,33 @@ and iterate through packages according to the order supplied in the file. All
 packages that matches `skip` in the YAML config file will be skipped during
 render.
 
+=== Usage of `lutaml_ea_xmi` macro
+
+This command is a replacement for `lutaml_uml_datamodel_description` to perform
+the same functionalities of `lutaml_uml_datamodel_description`, which is to
+render data model packages and its dependent objects for supplied XMI file, by
+using Liquid Drop.  The performance of `lutaml_ea_xmi` can be improved by
+10~20 times. (Tested with a 10.6MB XMI file with 120000+ lines)
+
+To use this macro, you only need to replace `lutaml_uml_datamodel_description`
+by `lutaml_ea_xmi`.
+
+Replace:
+
+[source,adoc]
+-----
+[lutaml_uml_datamodel_description, path/to/example.xmi]
+...
+-----
+
+By:
+
+[source,adoc]
+-----
+[lutaml_ea_xmi, path/to/example.xmi]
+...
+-----
+
 == Documentation
 
 Please refer to https://www.metanorma.org.

data/lib/metanorma/plugin/lutaml/liquid_templates/_klass_table.liquid

@@ -1,23 +1,24 @@
 [cols="1a,1a,2a"]
 |===
-| 型の定義
+| Definition of Type
 2+| {{ root.definition }}
 
-h| 上位の型 2+| {{ root.general.upper_klass }}:{{ root.general.name }}
-h| ステレオタイプ 2+| << {{ root.stereotype }} >>
+h| Upper Type 2+| {{ root.general.upper_klass }}:{{ root.general.name }}
+h| Stereotype 2+| << {{ root.stereotype }} >>
 
-3+h| 継承する属性
-h| 属性名 h| 属性の型及び多重度 h| 定義
+3+h| Inherited Properties
+h| Property Name h| Property Type and Multiplicity h| Definition
 {{ content.inherited_props }}
 
-3+h| 自身に定義された属性
+3+h| Self-defined Properties
+h| Property Name h| Property Type and Multiplicity h| Definition
 {{ content.owned_props }}
 
-3+h| 継承する関連役割
-h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
+3+h| Properties Inherited from Association
+h| Property Name h| Property Type and Multiplicity h| Definition
 {{ content.inherited_assoc_props }}
 
-3+h| 自身に定義された関連役割
-h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
+3+h| Properties Defined in Association
+h| Property Name h| Property Type and Multiplicity h| Definition
 {{ content.assoc_props }}
 |===

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

@@ -11,23 +11,23 @@ module Metanorma
       class LutamlKlassTableBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
         DEFAULT_TEMPLATE_PATH = File.join(
           Gem::Specification.find_by_name("metanorma-plugin-lutaml").gem_dir,
-          "lib/metanorma/plugin/lutaml/liquid_templates/<NAME>.liquid",
+          "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
         )
-        DEFAULT_TABLE_TEMPLATE = DEFAULT_TEMPLATE_PATH
-          .gsub("<NAME>", "_klass_table")
-        DEFAULT_ROW_TEMPLATE = DEFAULT_TEMPLATE_PATH
-          .gsub("<NAME>", "_klass_row")
-        DEFAULT_ASSOC_ROW_TEMPLATE = DEFAULT_TEMPLATE_PATH
-          .gsub("<NAME>", "_klass_assoc_row")
 
         use_dsl
         named :lutaml_klass_table
 
         def process(parent, target, attrs)
-          result_path = Utils.relative_file_path(parent.document, target)
+          xmi_path = Utils.relative_file_path(parent.document, target)
+
+          if attrs["tmpl_folder"]
+            attrs["tmpl_folder"] = Utils.relative_file_path(
+              parent.document, attrs["tmpl_folder"]
+            )
+          end
 
           gen = ::Lutaml::XMI::Parsers::XML.serialize_generalization_by_name(
-            result_path, attrs["name"]
+            xmi_path, attrs["name"]
           )
 
           render(gen, parent, attrs)
@@ -51,16 +51,6 @@ module Metanorma
             gen, parent, attrs
           )
 
-          # content[:inherited_props] += render_named_inherited_props(
-          #   gen, parent, attrs, "gml"
-          # )
-          # content[:inherited_props] += render_named_inherited_props(
-          #   gen, parent, attrs, "core"
-          # )
-          # content[:inherited_assoc_props] += render_named_inherited_props(
-          #   gen, parent, attrs, "gen"
-          # )
-
           rendered_table = render_table(gen, parent, attrs, content)
 
           block = create_open_block(parent, "", attrs)
@@ -69,7 +59,7 @@ module Metanorma
 
         def render_table(gen, parent, attrs, content)
           table_tmpl = get_template(
-            parent.document, attrs["table_template"], :table
+            parent.document, attrs, :table
           )
 
           table_tmpl.assigns["root"] = KlassTableDrop.new(gen)
@@ -81,14 +71,14 @@ module Metanorma
 
         def render_general_rows(general_item, parent, attrs)
           row_tmpl = get_template(
-            parent.document, attrs["row_template"], :row
+            parent.document, attrs, :row
           )
           render_rows(general_item, row_tmpl)
         end
 
         def render_assoc_rows(general_item, parent, attrs)
           row_tmpl = get_template(
-            parent.document, attrs["assoc_template"], :assoc_row
+            parent.document, attrs, :assoc_row
           )
           render_rows(general_item, row_tmpl)
         end
@@ -127,28 +117,6 @@ module Metanorma
           render_assoc_rows(gen, parent, attrs)
         end
 
-        def render_gml_inherited_props(gen, parent, attrs)
-          render_named_inherited_props(gen, parent, attrs, "gml")
-        end
-
-        def render_core_inherited_props(gen, parent, attrs)
-          render_named_inherited_props(gen, parent, attrs, "core")
-        end
-
-        def render_gen_inherited_props(gen, parent, attrs)
-          render_named_inherited_props(gen, parent, attrs, "gen")
-        end
-
-        def render_named_inherited_props(gen, parent, attrs, name)
-          attr_key = "#{name}_attributes".to_sym
-          general_item = {}
-          general_item[:general_attributes] = gen[attr_key]
-          general_item[:general_upper_klass] = gen[attr_key].first[:upper_klass]
-          general_item[:general_name] = name
-
-          render_general_rows(general_item, parent, attrs)
-        end
-
         def render_inherited_props(gen, parent, attrs)
           render_inherited_rows(gen, parent, attrs, assoc: false)
         end
@@ -173,10 +141,13 @@ module Metanorma
           rendered_rows
         end
 
-        def get_template(document, template_path, tmpl_type)
-          if template_path.nil?
-            template_path = get_default_template_path(tmpl_type)
+        def get_template(document, attrs, tmpl_type)
+          tmpl_folder = DEFAULT_TEMPLATE_PATH
+          if attrs["tmpl_folder"]
+            tmpl_folder = attrs["tmpl_folder"]
           end
+          template_path = get_default_template_path(tmpl_type, tmpl_folder,
+                                                    attrs)
 
           rel_tmpl_path = Utils.relative_file_path(
             document, template_path
@@ -185,15 +156,17 @@ module Metanorma
           ::Liquid::Template.parse(File.read(rel_tmpl_path))
         end
 
-        def get_default_template_path(tmpl_type)
-          case tmpl_type
-          when :row
-            DEFAULT_ROW_TEMPLATE
-          when :assoc_row
-            DEFAULT_ASSOC_ROW_TEMPLATE
-          else
-            DEFAULT_TABLE_TEMPLATE
-          end
+        def get_default_template_path(tmpl_type, tmpl_folder, attrs)
+          liquid_template = case tmpl_type
+                            when :row
+                              attrs["row_tmpl_name"] || "_klass_row"
+                            when :assoc_row
+                              attrs["assoc_row_tmpl_name"] || "_klass_assoc_row"
+                            else
+                              attrs["table_tmpl_name"] || "_klass_table"
+                            end
+
+          File.join(tmpl_folder, "#{liquid_template}.liquid")
         end
       end
     end

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

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.9".freeze
+      VERSION = "0.7.10".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.9
+  version: 0.7.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor