metanorma-plugin-lutaml 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59529d97e0b2a61af4daf695ab6e3490ccdb5e99f5a351e53ab8c822c063a17
-  data.tar.gz: 2a30e8db498027922dc4f848057880a13d4a240310b2c01122ed2176be4cbf2e
+  metadata.gz: '091036d68a92b76cdfb383ae829bd65182a26ddc1146cce1d844a5646c27ca83'
+  data.tar.gz: 39bfe3ec5d4b57985902f5ab17f6d097db903f3151efee95068cefe4d2861f5e
 SHA512:
-  metadata.gz: e5b8fffe0ec8df9e9ae6bddff29202f9c65a40b43a4790980799763cad78f950cab5c59f0b07ac6c7e774f4199f9aa5cf9c9ec2470d4d67622d3e491416de09e
-  data.tar.gz: c530eea53a62605af3df803eeddffdb5feee15e91856dff2541fe2b5831cd5e27ad5052fab01d101763eb9a890b0154aad28a934a40caf980111d2647eda5448
+  metadata.gz: 4276c20cae2b83cc37b562217429e00b951a2e0a73bf384f931b47bd94b71774db3b42d62cfc1c380bf3b64bf9b6d5c6b8d98fbe18b5b2d9426558ba8aa40a1e
+  data.tar.gz: 4323e58139487b3192af2da916a8142f1bd56b7cf8d2df3dae2882172ea7cf22c10e0cfd4d31278cbd3e731f2a689ab871e6a5baa1d89d462a95df90ab389500

data/Gemfile

@@ -12,4 +12,6 @@ rescue StandardError
   nil
 end
 
+# gem "lutaml", path: "../../lutaml/lutaml"
+
 gem "ogc-gml", github: "lutaml/ogc-gml"

data/lib/metanorma/plugin/lutaml/liquid_drops/klass_table_attribute_drop.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+class KlassTableAttributeDrop < Liquid::Drop
+  LOWER_VALUE_MAPPINGS = {
+    "C" => "0",
+    "M" => "1",
+  }.freeze
+
+  def initialize(attr) # rubocop:disable Lint/MissingSuper
+    @attr = attr
+  end
+
+  def id
+    @attr[:id]
+  end
+
+  def name
+    @attr[:name]
+  end
+
+  def type
+    @attr[:type]
+  end
+
+  def xmi_id
+    @attr[:xmi_id]
+  end
+
+  def is_derived
+    @attr[:is_derived]
+  end
+
+  def cardinality
+    min = @attr[:cardinality]["min"]
+    min = min.nil? ? nil : LOWER_VALUE_MAPPINGS[min]
+
+    "#{min}..#{@attr[:cardinality]['max']}"
+  end
+
+  def definition
+    @attr[:definition]
+  end
+
+  def association
+    @attr[:association]
+  end
+
+  def has_association?
+    !!@attr[:association]
+  end
+
+  def upper_klass
+    @attr[:upper_klass]
+  end
+
+  def name_ns
+    @attr[:name_ns]
+  end
+
+  def type_ns
+    @attr[:type_ns]
+  end
+
+  def gen_name
+    @attr[:gen_name]
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid_drops/klass_table_content_drop.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class KlassTableContentDrop < Liquid::Drop
+  def initialize(content) # rubocop:disable Lint/MissingSuper
+    @content = content
+  end
+
+  def owned_props
+    @content[:owned_props]
+  end
+
+  def assoc_props
+    @content[:assoc_props]
+  end
+
+  def inherited_props
+    @content[:inherited_props]
+  end
+
+  def inherited_assoc_props
+    @content[:inherited_assoc_props]
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid_drops/klass_table_drop.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class KlassTableDrop < Liquid::Drop
+  def initialize(klass) # rubocop:disable Lint/MissingSuper
+    @klass = klass
+  end
+
+  def id
+    @klass[:general_id]
+  end
+
+  def name
+    @klass[:name]
+  end
+
+  def stereotype
+    @klass[:stereotype]
+  end
+
+  def definition
+    @klass[:definition]
+  end
+
+  def type
+    @klass[:type]
+  end
+
+  def upper_klass
+    @klass[:general_upper_klass]
+  end
+
+  def general
+    KlassTableGeneralDrop.new(@klass[:general]) if @klass[:general]
+  end
+
+  def has_general?
+    !!@klass[:general]
+  end
+
+  def attributes
+    @klass[:general_attributes].map do |attr|
+      KlassTableAttributeDrop.new(attr)
+    end
+  end
+end

data/lib/metanorma/plugin/lutaml/liquid_drops/klass_table_general_drop.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class KlassTableGeneralDrop < Liquid::Drop
+  def initialize(gen) # rubocop:disable Lint/MissingSuper
+    @gen = gen
+  end
+
+  def id
+    @gen[:general_id]
+  end
+
+  def name
+    @gen[:general_name]
+  end
+
+  def upper_klass
+    @gen[:general_upper_klass]
+  end
+
+  def general
+    KlassTableGeneralDrop.new(@gen[:general]) if @gen[:general]
+  end
+
+  def has_general?
+    !!@gen[:general]
+  end
+
+  def attributes
+    @gen[:general_attributes].map do |attr|
+      KlassTableAttributeDrop.new(attr)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+{%- for attr in attributes -%}
+  {%- if attr.has_association? != false -%}
+    {%- capture name_col -%}
+      {{ attr.name_ns }}:{{ attr.name }}
+      ({{ attr.gen_name }})
+    {%- endcapture -%}
+    | {{ name_col | newline_to_br }}
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.definition }}
+  {%- endif -%}
+{%- endfor -%}

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

@@ -0,0 +1,11 @@
+{%- for attr in attributes -%}
+  {%- if attr.has_association? == false -%}
+    {%- capture name_col -%}
+      {{ attr.name_ns }}:{{ attr.name }}
+      ({{ attr.gen_name }})
+    {%- endcapture -%}
+    | {{ name_col | newline_to_br }}
+    | {{ attr.type }} [{{ attr.cardinality }}] 
+    | {{ attr.definition }}
+  {%- endif -%}
+{%- endfor -%}

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

@@ -0,0 +1,23 @@
+[cols="1a,1a,2a"]
+|===
+| 型の定義
+2+| {{ root.definition }}
+
+h| 上位の型 2+| {{ root.general.upper_klass }}:{{ root.general.name }}
+h| ステレオタイプ 2+| << {{ root.stereotype }} >>
+
+3+h| 継承する属性
+h| 属性名 h| 属性の型及び多重度 h| 定義
+{{ content.inherited_props }}
+
+3+h| 自身に定義された属性
+{{ content.owned_props }}
+
+3+h| 継承する関連役割
+h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
+{{ content.inherited_assoc_props }}
+
+3+h| 自身に定義された関連役割
+h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
+{{ content.assoc_props }}
+|===

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

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require_relative "liquid_drops/klass_table_drop"
+require_relative "liquid_drops/klass_table_attribute_drop"
+require_relative "liquid_drops/klass_table_general_drop"
+require_relative "liquid_drops/klass_table_content_drop"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      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",
+        )
+        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)
+
+          gen = ::Lutaml::XMI::Parsers::XML.serialize_generalization_by_name(
+            result_path, attrs["name"]
+          )
+
+          render(gen, parent, attrs)
+        end
+
+        private
+
+        def render(gen, parent, attrs) # rubocop:disable Metrics/MethodLength
+          content = {}
+
+          content[:owned_props] = render_owned_props(
+            gen, parent, attrs
+          )
+          content[:assoc_props] = render_assoc_props(
+            gen, parent, attrs
+          )
+          content[:inherited_props] = render_inherited_props(
+            gen, parent, attrs
+          )
+          content[:inherited_assoc_props] = render_inherited_assoc_props(
+            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)
+          parse_content(block, rendered_table, attrs)
+        end
+
+        def render_table(gen, parent, attrs, content)
+          table_tmpl = get_template(
+            parent.document, attrs["table_template"], :table
+          )
+
+          table_tmpl.assigns["root"] = KlassTableDrop.new(gen)
+          table_tmpl.assigns["content"] =
+            KlassTableContentDrop.new(content)
+
+          table_tmpl.render
+        end
+
+        def render_general_rows(general_item, parent, attrs)
+          row_tmpl = get_template(
+            parent.document, attrs["row_template"], :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
+          )
+          render_rows(general_item, row_tmpl)
+        end
+
+        def render_rows(general_item, row_tmpl)
+          gen_attrs = general_item[:general_attributes]
+          upper_klass = general_item[:general_upper_klass]
+          gen_name = general_item[:general_name]
+          attributes = prepare_row_drops(gen_attrs, upper_klass, gen_name)
+          row_tmpl.assigns["attributes"] = attributes
+          row_tmpl.render
+        end
+
+        def prepare_row_drops(gen_attrs, upper_klass, gen_name) # rubocop:disable Metrics/MethodLength
+          gen_attrs.map do |attr|
+            attr[:gen_name] = gen_name
+            attr[:upper_klass] = upper_klass
+            attr[:name_ns] = case attr[:type_ns]
+                             when "core", "gml"
+                               upper_klass
+                             else
+                               attr[:type_ns]
+                             end
+
+            attr[:name_ns] = upper_klass if attr[:name_ns].nil?
+
+            KlassTableAttributeDrop.new(attr)
+          end
+        end
+
+        def render_owned_props(gen, parent, attrs)
+          render_general_rows(gen, parent, attrs)
+        end
+
+        def render_assoc_props(gen, parent, attrs)
+          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
+
+        def render_inherited_assoc_props(gen, parent, attrs)
+          render_inherited_rows(gen, parent, attrs, assoc: true)
+        end
+
+        def render_inherited_rows(gen, parent, attrs, assoc: false) # rubocop:disable Metrics/MethodLength
+          rendered_rows = ""
+          general_item = gen[:general]
+
+          while general_item && !general_item.empty?
+            rendered_rows += if assoc
+                               render_assoc_rows(general_item, parent, attrs)
+                             else
+                               render_general_rows(general_item, parent, attrs)
+                             end
+            general_item = general_item[:general]
+          end
+
+          rendered_rows
+        end
+
+        def get_template(document, template_path, tmpl_type)
+          if template_path.nil?
+            template_path = get_default_template_path(tmpl_type)
+          end
+
+          rel_tmpl_path = Utils.relative_file_path(
+            document, template_path
+          )
+
+          ::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
+        end
+      end
+    end
+  end
+end

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

@@ -121,10 +121,10 @@ options)
                 end
               end
             end
-            children_pks_daigs = package_flat.call(all_children_packages)
+            children_pks_diags = package_flat.call(all_children_packages)
             ref_dictionary = ref_dictionary
               .merge(package_flat.call(lutaml_document.packages)
-                                      .merge(children_pks_daigs))
+                                      .merge(children_pks_diags))
           end
           document.attributes["lutaml_entity_id"] = ref_dictionary
         end
@@ -138,12 +138,12 @@ options)
               end
             end
           end
-          children_pks_daigs = package_flat_diagrams.call(
+          children_pks_diags = package_flat_diagrams.call(
             lutaml_document.packages.map(&:children_packages).flatten,
           )
           document.attributes["lutaml_figure_id"] = package_flat_diagrams
             .call(lutaml_document.packages)
-            .merge(children_pks_daigs)
+            .merge(children_pks_diags)
         end
 
         def collect_additional_context(document, input_lines, end_mark)
@@ -265,7 +265,7 @@ options)
 
         def config_entity_regexp(entity)
           additional_sym = ".*" if /\*$/.match?(entity)
-          %r{^#{Regexp.escape(entity.gsub('*', ''))}#{additional_sym}$}
+          %r{^#{Regexp.escape(entity.delete('*'))}#{additional_sym}$}
         end
 
         def model_representation(lutaml_document, document, additional_context,

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -11,6 +11,7 @@ require "metanorma/plugin/lutaml/lutaml_ea_diagram_block_macro"
 require "metanorma/plugin/lutaml/lutaml_gml_dictionary_base"
 require "metanorma/plugin/lutaml/lutaml_gml_dictionary_block_macro"
 require "metanorma/plugin/lutaml/lutaml_gml_dictionary_block"
+require "metanorma/plugin/lutaml/lutaml_klass_table_block_macro"
 
 module Metanorma
   module Plugin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -332,7 +332,14 @@ files:
 - lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb
 - lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_drop.rb
 - lib/metanorma/plugin/lutaml/liquid_drops/gml_dictionary_entry_drop.rb
+- lib/metanorma/plugin/lutaml/liquid_drops/klass_table_attribute_drop.rb
+- lib/metanorma/plugin/lutaml/liquid_drops/klass_table_content_drop.rb
+- lib/metanorma/plugin/lutaml/liquid_drops/klass_table_drop.rb
+- lib/metanorma/plugin/lutaml/liquid_drops/klass_table_general_drop.rb
 - lib/metanorma/plugin/lutaml/liquid_templates/_diagrams_block.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_klass_assoc_row.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_klass_row.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_klass_table.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary.liquid
@@ -352,6 +359,7 @@ files:
 - lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_base.rb
 - lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_gml_dictionary_block_macro.rb
+- lib/metanorma/plugin/lutaml/lutaml_klass_table_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_table_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb