metanorma-plugin-lutaml 0.4.9 → 0.4.10

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

@@ -1,3 +1,3 @@
 {% for klass in classes %}
-{% include "packages_data_dictionary_class" %}
+{% include "packages_data_dictionary_class", depth: depth %}
 {% endfor %}

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

@@ -4,7 +4,7 @@
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
 [[section-{{ klass.xmi_id }}]]
-.Elements of {{ package.name }}::{{ klass.name }}” (data_type)
+.Definition table of “{{ package.name }}::{{ klass.name }}” ({{ klass.stereotype }})
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 

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

@@ -2,17 +2,33 @@
 {% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
 {% if additional_context.before and additional_context.before.size > 0 %}
 {% for before in additional_context.before %}
+{% if before.liquid %}
+{{ before.text | interpolate }}
+{% else %}
 {{ before.text }}
+{% endif %}
+{% endfor %}
+{% endif %}
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] %}
+{% for before in additional_context[before_package_key] %}
+{% if before.liquid %}
+{{ before.text | interpolate }}
+{% else %}
+{{ before.text }}
+{% endif %}
 {% endfor %}
 {% endif %}
 {% if depth %}
+{% assign nested_depth = depth | plus: 1 %}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
 [[rc_{{ package_name }}-model_section]]
-{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
+{{equalsigns}} {{ package.name }}
 {% endif %}
 
-{% if additional_context.all_macroses.size > 0 %}
-{% assign sorted_all_macroses = additional_context.all_macroses | where: "position", "before" | sort: 'index' %}
-{% for block in sorted_all_macroses %}
+{% if additional_context.all_macros.size > 0 %}
+{% assign sorted_all_macros = additional_context.all_macros | where: "position", "before" | sort: 'index' %}
+{% for block in sorted_all_macros %}
 {% case block.type %}
 {% when 'include_block' %}
 {% unless block.package and block.package != package.name %}
@@ -21,8 +37,12 @@
 {% unless block_content contains "Liquid error" %}
 {% if block.text %}
 
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
 {{ block.text }}
 {% endif %}
+{% endif %}
 
 {{ block_content }}
 {% endunless %}
@@ -30,14 +50,18 @@
 {% when 'package_text' %}
 {% unless block.package and block.package != package.name %}
 
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
 {{ block.text }}
+{% endif %}
 {% endunless %}
 {% else %}
 {% endcase %}
 {% endfor %}
 {% endif %}
 
-// TODO: move to all_macroses block
+{% comment %} // TODO: move to all_macros block {% endcomment %}
 {% if additional_context.diagram_include_block %}
 {% for diagram_include_block in additional_context.diagram_include_block %}
 {% include "diagrams_block", package_name: package_name, image_base_path: diagram_include_block.base_path, text: diagram_include_block.text %}
@@ -45,57 +69,66 @@
 {% endif %}
 
 {% if package.classes.size > 0 %}
+{% unless package_skip_sections[package.name]['classes'] %}
 {{equalsigns}}= Class definitions
 
+{% endunless %}
 {% comment %} {% assign data_types = package.classes | where: "stereotype", "DataType" %} {% endcomment %}
 {% assign basic_types = package.classes | where: "stereotype", "BasicType" %}
 {% comment %} {% assign enumerations = package.classes | where: "stereotype", "Enumeration" %} {% endcomment %}
 {% assign code_lists = package.classes | where: "stereotype", "CodeList" %}
+{% assign unions = package.data_types | where: "stereotype", "Union" %}
 
 {% assign not_classes_length = plus: basic_types.size | plus: code_lists.size %}
-{% assign not_classes_stereoptypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
-{% unless not_classes_length == package.classes.size %}
-.Classes used in {{ package.name }}
+{% assign not_classes_stereotypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+{% unless not_classes_length == package.classes.size or package_skip_sections[package.name]['classes'] %}
+.Classes defined in {{ package.name }} ({{ package.stereotype }})
 [cols="2a,6a",options="header"]
 |===
 |Name |Description
+
 {% for klass in package.classes %}
-{% unless not_classes_stereoptypes contains klass.stereotype  %}
-|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
-|{{ klass.definition }}
+{% unless not_classes_stereotypes contains klass.stereotype %}
+| <<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+| {{ klass.definition | replace: '|', '\|' }}
 
 {% endunless %}
 {% endfor %}
 |===
 {% endunless %}
 
-{% if package.data_types.size > 0 %}
-{% include "packages_entity_list_classes", classes: package.data_types, type: "Data Types" %}
+{% assign non_unions = package.data_types | where: "stereotype", "DataType"  %}
+{% if non_unions.size > 0 %}
+{% include "packages_entity_list_classes", classes: non_unions, type: "Data types", depth: nested_depth %}
 {% endif %}
 
 {% if basic_types.size > 0 %}
-{% include "packages_entity_list_classes", classes: basic_types, type: "Primitive Data Types" %}
+{% include "packages_entity_list_classes", classes: basic_types, type: "Primitive data types", depth: nested_depth %}
 {% endif %}
 
 {% if package.enums.size > 0 %}
-{% include "packages_entity_list_classes", classes: package.enums, type: "Enumerated Classes" %}
+{% include "packages_entity_list_classes", classes: package.enums, type: "Enumerated classes", depth: nested_depth %}
+{% endif %}
+
+{% if unions.size > 0 %}
+{% include "packages_entity_list_classes", classes: unions, type: "Union types", depth: nested_depth %}
 {% endif %}
 
 {% if code_lists.size > 0 %}
-{% include "packages_entity_list_classes", classes: code_lists, type: "CodeList Classes" %}
+{% include "packages_entity_list_classes", classes: code_lists, type: "Code list classes", depth: nested_depth %}
 {% endif %}
 
 {% endif %}
 
 {% comment %} {% if package.data_types.size > 0 %}
 .Data types used in {{ package.name }}
-[cols="2,6",options="header"]
+[cols="2a,6a",options="header"]
 |===
 |Name |Description
 
 {% for klass in package.data_types %}
 |<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
-|{{ klass.definition }}
+|{{ klass.definition | replace: '|', '\|' }}
 
 {% endfor %}
 
@@ -110,27 +143,69 @@
 
 {% for klass in package.enums %}
 |<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
-|{{ klass.definition }}
+|{{ klass.definition | replace: '|', '\|' }}
 
 {% endfor %}
 
 |===
 {% endif %} {% endcomment %}
 
+{% if additional_context.all_macros.size > 0 %}
+{% assign sorted_all_macros = additional_context.all_macros | where: "position", "after" | sort: 'index' %}
+{% for block in sorted_all_macros %}
+{% case block.type %}
+{% when 'include_block' %}
+{% unless block.package and block.package != package.name %}
+{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
+{% capture block_content %}{% include block_filename %}{% endcapture %}
+{% unless block_content contains "Liquid error" %}
+{% if block.text %}
+
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
+{{ block.text }}
+{% endif %}
+{% endif %}
+
+{{ block_content }}
+{% endunless %}
+{% endunless %}
+{% when 'package_text' %}
+{% unless block.package and block.package != package.name %}
+
+{% if block.liquid %}
+{{ block.text | interpolate }}
+{% else %}
+{{ block.text }}
+{% endif %}
+{% endunless %}
+{% else %}
+{% endcase %}
+{% endfor %}
+{% endif %}
+
 {% assign after_package_key = 'after;' | append: package.name %}
 {% if additional_context[after_package_key] %}
-{{equalsigns}}= Additional information
 {% for after in additional_context[after_package_key] %}
+{% if after.liquid %}
+{{ after.text | interpolate }}
+{% else %}
 {{ after.text }}
+{% endif %}
 {% endfor %}
 {% endif %}
 {% if package.packages.size > 0 and render_nested_packages %}
-{% assign nested_depth = depth | plus: 1 %}{% include "packages_entity_list", depth: nested_depth, context: package %}
+{% include "packages_entity_list", depth: nested_depth, context: package %}
 {% endif %}
 {% endfor %}
 
 {% if additional_context.after and additional_context.after.size > 0 %}
 {% for after in additional_context.after %}
+{% if after.liquid %}
+{{ after.text | interpolate }}
+{% else %}
 {{ after.text }}
+{% endif %}
 {% endfor %}
 {% endif %}

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

@@ -0,0 +1,19 @@
+{% for package in context.packages %}
+{% assign not_classes_stereotypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+[cols="2a,6a",options="header"]
+|===
+|Class |Description
+
+{% for klass in package.classes %}
+{% assign klass_name = klass.name %}
+{% assign package_name = package.name %}
+{% unless package_entities and package_entities[package_name][klass_name] != true %}
+{% unless not_classes_stereotypes contains klass.stereotype %}
+| <<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
+| {{ klass.definition | replace: '|', '\|' }}
+
+{% endunless %}
+{% endunless %}
+{% endfor %}
+|===
+{% endfor %}

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

@@ -1,11 +1,11 @@
-.{{ type }} used in {{ package.name }}
+.{{ type }} defined in {{ package.name }} ({{ package.stereotype }})
 [cols="2a,6a",options="header"]
 |===
 |Name |Description
 
 {% for klass in classes %}
-|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype | default: "Enumeration" }}»
-|{{ klass.definition }}
+| <<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype | default: "Enumeration" }}»
+| {{ klass.definition | replace: '|', '\|' }}
 
 {% endfor %}
 |===

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

@@ -5,7 +5,7 @@
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
 
 [[section-{{ klass.xmi_id }}]]
-.Elements of {{ package.name }}::{{ klass.name }}” (enum)
+.Definition table of “{{ package.name }}::{{ klass.name }}” ({{ klass.stereotype }})
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -60,5 +60,4 @@ h| Values:
 7+| (none)
 {% endif %}
 
-
 |===

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

@@ -52,7 +52,7 @@ module Metanorma
 
         def process_text_blocks(document, input_lines, express_indexes)
           line = input_lines.next
-          block_match = line.match(/^\[lutaml_express,([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
+          block_match = line.match(/^\[(?:\blutaml\b|\blutaml_express\b),([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
           return [line] if block_match.nil?
 
           end_mark = input_lines.next

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

@@ -87,7 +87,7 @@ module Metanorma
           {% else %}
           .{{ definition.name }} attributes
           |===
-          |Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
+          |Name |Definition |Mandatory / Optional / Conditional |Max Occur |Data Type
 
           {% for item in definition.attributes %}
           |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% endif %} |{% if item.cardinality.min == "0" %}O{% else %}M{% endif %} |{% if item.cardinality.max == "*" %}N{% else %}1{% endif %} |{% if item.origin %}<<{{ item.origin }}>>{% endif %} `{{ item.type }}`

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

@@ -24,6 +24,7 @@ module Metanorma
         RENDER_STYLES_INCLUDES = {
           'default' => 'packages',
           'entity_list' => 'packages_entity_list',
+          'entity_list_class' => 'packages_entity_list_class',
           'data_dictionary' => 'packages_data_dictionary'
         }.freeze
         RENDER_STYLE_ATTRIBUTE = 'render_style'.freeze
@@ -39,11 +40,19 @@ module Metanorma
 
         private
 
-        def lutaml_document_from_file(document, file_path)
-          ::Lutaml::Parser
-            .parse(File.new(Utils.relative_file_path(document, file_path),
-                            encoding: "UTF-8"))
-            .first
+        def lutaml_document_from_file_or_cache(document, file_path)
+          full_path = Utils.relative_file_path(document, file_path)
+          if document.attributes['lutaml_xmi_cache'] &&
+              document.attributes['lutaml_xmi_cache'][full_path]
+            return document.attributes['lutaml_xmi_cache'][full_path]
+          end
+          result_document = ::Lutaml::Parser.parse(File.new(full_path,
+                                encoding: "UTF-8"))
+                              .first
+                              result_document
+          document.attributes['lutaml_xmi_cache'] ||= {}
+          document.attributes['lutaml_xmi_cache'][full_path] = result_document
+          result_document
         end
 
         def parse_yaml_config_file(document, file_path)
@@ -66,12 +75,12 @@ module Metanorma
           block_match = line.match(MARCO_REGEXP)
           return [line] if block_match.nil?
 
-          lutaml_document = lutaml_document_from_file(document, block_match[1])
+          lutaml_document = lutaml_document_from_file_or_cache(document, block_match[1])
           fill_in_diagrams_attributes(document, lutaml_document)
           model_representation(
             lutaml_document,
             document,
-            collect_additional_context(input_lines, input_lines.next),
+            collect_additional_context(document, input_lines, input_lines.next),
             parse_yaml_config_file(document, block_match[2]))
         end
 
@@ -116,14 +125,17 @@ module Metanorma
                                                       .merge(children_pks_daigs)
         end
 
-        def collect_additional_context(input_lines, end_mark)
+        def collect_additional_context(document, input_lines, end_mark)
           additional_context = Hash.new { |hash, key| hash[key] = [] }
-          additional_context['all_macroses'] = []
+          additional_context['all_macros'] = []
           block_lines = []
           while (block_line = input_lines.next) != end_mark
             block_lines.push(block_line)
           end
-          block_document = (Asciidoctor::Document.new(block_lines, {})).parse
+          processed_lines = self
+                              .process(document, Asciidoctor::Reader.new(block_lines))
+                              .read_lines
+          block_document = (Asciidoctor::Document.new(processed_lines, {})).parse
           block_document.blocks.each do |block|
             next unless SUPPORTED_NESTED_MACRO.include?(block.attributes['role'])
 
@@ -133,7 +145,7 @@ module Metanorma
             macro_keyword = [name, package].compact.join(";")
             block_text = block.lines.length > 0 ? block.lines.join("\n") : ''
             additional_context[macro_keyword].push({ 'text' => block_text }.merge(attrs))
-            additional_context['all_macroses'].push({ 'text' => block_text, 'type' => name, 'package' => package }.merge(attrs))
+            additional_context['all_macros'].push({ 'text' => block_text, 'type' => name, 'package' => package }.merge(attrs))
           end
           additional_context
         end
@@ -159,12 +171,30 @@ module Metanorma
           all_packages = [root_package, *root_package['children_packages']]
           {
             "packages" => sort_and_filter_out_packages(all_packages, options),
+            "package_entities" => package_entities(options),
+            "package_skip_sections" => package_skip_sections(options),
             "additional_context" => additional_context,
             "root_packages" => [root_package],
             "name" => root_package['name']
           }
         end
 
+        def package_entities(options)
+          return {} unless options['packages']
+
+          options['packages']
+            .find_all { |entity| entity.is_a?(Hash) && entity.values.first['render_entities'] }
+            .map { |entity| [entity.keys.first, entity.values.first['render_entities'].map { |n| [n, true] }.to_h] }.to_h
+        end
+
+        def package_skip_sections(options)
+          return {} unless options['packages']
+
+          options['packages']
+            .find_all { |entity| entity.is_a?(Hash) && entity.values.first['skip_tables'] }
+            .map { |entity| [entity.keys.first, entity.values.first['skip_tables'].map { |n| [n, true] }.to_h] }.to_h
+        end
+
         def sort_and_filter_out_packages(all_packages, options)
           return all_packages if options['packages'].nil?
 
@@ -179,8 +209,9 @@ module Metanorma
             end
           # Step two - select supplied packages by pattern
           options['packages']
-            .find_all { |entity| entity.is_a?(String) }
-            .each do |entity|
+            .find_all { |entity| entity.is_a?(String) || (entity.is_a?(Hash) && !entity['skip']) }
+            .each do |entity_obj|
+              entity = entity_obj.is_a?(String) ? entity_obj : entity_obj.keys.first
               entity_regexp = config_entity_regexp(entity)
               all_packages.each.with_index do |package|
                 if package['name'] =~ entity_regexp
@@ -218,11 +249,11 @@ module Metanorma
           result = ""
           if include_root
             result += <<~LIQUID
-              {% include "#{include_name}", context: context.root_packages, additional_context: context.additional_context, render_nested_packages: false %}
+              {% include "#{include_name}", package_skip_sections: context.package_skip_sections, package_entities: context.package_entities, context: context.root_packages, additional_context: context.additional_context, render_nested_packages: false %}
             LIQUID
           end
           result += <<~LIQUID
-            {% include "#{include_name}", depth: #{section_depth}, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
+            {% include "#{include_name}", depth: #{section_depth}, package_skip_sections: context.package_skip_sections, package_entities: context.package_entities, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
           LIQUID
         end
       end

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

@@ -7,7 +7,7 @@ require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"
 module Metanorma
   module Plugin
     module Lutaml
-      # Helpers for lutaml macroses
+      # Helpers for lutaml macros
       module Utils
         LUTAML_EXP_IDX_TAG = /^:lutaml-express-index:(?<index_name>.+?);(?<index_path>.+?);?(\s*cache=(?<cache_path>.+))?$/.freeze