metanorma-plugin-lutaml 0.4.2 → 0.4.6

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

@@ -0,0 +1,113 @@
+{% for package in context.packages %}
+{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
+{% if additional_context.before and additional_context.before.size > 0 %}
+{% for before in additional_context.before %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
+[[rc_{{ package_name }}-model_section]]
+{{equalsigns}}= {{ package.name }}
+
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
+{% for before in additional_context[before_package_key] %}
+{{ before.text }}
+{% endfor %}
+{% endif %}
+{% 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 %}
+{% endfor %}
+{% endif %}
+
+{% if additional_context.include_block and additional_context.include_block.size > 0 %}
+{% for block in additional_context.include_block %}
+{% 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 %}
+{{ block.text }}
+{% endif %}
+{{ block_content }}
+{% endunless %}
+{% endfor %}
+{% endif %}
+
+{% assign include_block_package_key = 'include_block;' | append: package.name %}
+{% if additional_context[include_block_package_key] and additional_context[include_block_package_key].size > 0 %}
+{% for block in additional_context[include_block_package_key] %}
+{% 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 %}
+{{ block.text }}
+{% endif %}
+{{ block_content }}
+{% endunless %}
+{% endfor %}
+{% endif %}
+
+{{equalsigns}}= Class Definitions
+{% if package.classes.size > 0 %}
+.Classes used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Class |Description
+
+{% for klass in package.classes %}
+|<<{{ klass.name }}-section,{{ klass.name }}>>
+«{{ klass.stereotype }}»
+|{{ klass.definition }}
+
+{% endfor %}
+|===
+{% endif %}
+
+{% if package.data_types.size > 0 %}
+.Data Types used in {{ package.name }}
+[cols="2,6",options="header"]
+|===
+|Name |Description
+
+{% for klass in package.data_types %}
+|<<{{ klass.name }}-section,{{ klass.name }}>>
+|{{ klass.definition }}
+
+{% endfor %}
+
+|===
+{% endif %}
+
+{% if package.enums.size > 0 %}
+.Enumerated Classes used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Name |Description
+
+{% for klass in package.enums %}
+|<<{{ klass.name }}-section,{{ klass.name }}>>
+|{{ klass.definition }}
+
+{% 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] %}
+{{ after.text }}
+{% 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 %}
+{% endif %}
+{% endfor %}
+
+{% if additional_context.after and additional_context.after.size > 0 %}
+{% for after in additional_context.after %}
+{{ after.text }}
+{% endfor %}
+{% endif %}

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

@@ -0,0 +1,63 @@
+{% assign is_klass_spare = klass.name | slice: 0,5 %}
+{% if is_klass_spare == 'old: ' %}{% continue %}
+{% elsif is_klass_spare == 'Spare' %}{% continue %}
+{% endif %}
+{% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
+[[tab-P-{{ package_name }}-E-{{ klass_name }}]]
+.Elements of {{ package.name }}::{{ klass.name }}
+[width="100%",cols="a,a,a,a,a,a,a,a"]
+|===
+
+h|Name: 7+| {{ klass.name }}
+
+h|Definition: 7+| {{ klass.definition | html2adoc }}
+
+h|Stereotype: 7+| {{ klass.stereotype | default: 'interface' }}
+
+{% assign inherited = klass.associations | where: "member_end_type", "inheritance" %}
+{% if inherited.size > 0 %}
+h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
+{% endif %}
+
+{% assign generalizations = klass.associations | where: "member_end_type", "generalization" %}
+{% if generalizations.size > 0 %}
+h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
+{% endif %}
+
+h|Abstract: 7+| {{ klass.is_abstract }}
+{% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
+{% if aggregations.size > 0 %}
+.{{aggregations.size | plus: 1}}+h|Associations:
+4+|_Association with:_
+|_Obligation_
+| _Maximum occurrence_
+|_Provides:_
+
+{% for assoc in aggregations %}
+4+| {{assoc.member_end}}
+| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.min }}{% endif %}
+| {% if assoc.member_end_cardinality %}{{ assoc.member_end_cardinality.max }}{% endif %}
+| {{ assoc.member_end_attribute_name }}
+
+{% endfor %}
+{% else %}
+
+.1+h|Associations: 7+| (none)
+{% endif %}
+{% if klass.values.size > 0 %}
+.{{klass.values.size | plus: 1}}+h|Values:
+| _Name_
+6+| _Definition_
+
+{% for value in klass.values %}
+| {{value.name}}
+6+| {{ value.definition | html2adoc }}
+
+{% endfor %}
+{% else %}
+.1+h|Values:
+7+| (none)
+{% endif %}
+
+
+|===

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "asciidoctor"
+require "asciidoctor/reader"
+require "lutaml"
+require "lutaml/uml"
+require "lutaml/formatter"
+require "metanorma/plugin/lutaml/utils"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      module LutamlDiagramBase
+        def process(parent, reader, attrs)
+          uml_document = ::Lutaml::Uml::Parsers::Dsl.parse(lutaml_file(parent.document, reader))
+          filename = generate_file(parent, reader, uml_document)
+          through_attrs = generate_attrs(attrs)
+          through_attrs["target"] = filename
+          through_attrs["title"] = uml_document.caption
+          create_image_block(parent, through_attrs)
+        rescue StandardError => e
+          abort(parent, reader, attrs, e.message)
+        end
+
+        def lutaml_file(reader)
+          raise 'Implement me!'
+        end
+
+        protected
+
+        def abort(parent, reader, attrs, msg)
+          warn(msg)
+          attrs["language"] = "lutaml"
+          source = reader.respond_to?(:source) ? reader.source : reader
+          create_listing_block(
+            parent,
+            source,
+            attrs.reject { |k, _v| k == 1 }
+          )
+        end
+
+        # if no :imagesdir: leave image file in lutaml
+        def generate_file(parent, _reader, uml_document)
+          formatter = ::Lutaml::Formatter::Graphviz.new
+          formatter.type = :png
+
+          imagesdir = if parent.document.attr("imagesdir")
+                        File.join(parent.document.attr("imagesdir"), "lutaml")
+                      else
+                        "lutaml"
+                      end
+          result_path = Utils.relative_file_path(parent.document, imagesdir)
+          result_pathname = Pathname.new(result_path)
+          result_pathname.mkpath
+          File.writable?(result_pathname) || raise("Destination path #{result_path} not writable for Lutaml!")
+
+          outfile = Tempfile.new(["lutaml", ".png"])
+          outfile.binmode
+          outfile.puts(formatter.format(uml_document))
+
+          # Warning: metanorma/metanorma-standoc#187
+          # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
+          # This is why we need to copy and then unlink.
+          filename = File.basename(outfile.path)
+          FileUtils.cp(outfile, result_pathname) && outfile.unlink
+
+          File.join(result_pathname, filename)
+        end
+
+        def generate_attrs(attrs)
+          %w(id align float title role width height alt)
+            .reduce({}) do |memo, key|
+              memo[key] = attrs[key] if attrs.has_key? key
+              memo
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -1,40 +1,21 @@
 # frozen_string_literal: true
 
-require "liquid"
-require "asciidoctor"
-require "asciidoctor/reader"
-require "lutaml"
-require "lutaml/uml"
-require "metanorma/plugin/lutaml/utils"
+require "metanorma/plugin/lutaml/lutaml_diagram_base"
 
 module Metanorma
   module Plugin
     module Lutaml
       class LutamlDiagramBlock < Asciidoctor::Extensions::BlockProcessor
+        include LutamlDiagramBase
+
         use_dsl
         named :lutaml_diagram
         on_context :literal
         parse_content_as :raw
 
-        def abort(parent, reader, attrs, msg)
-          warn(msg)
-          attrs["language"] = "lutaml"
-          create_listing_block(
-            parent,
-            reader.source,
-            attrs.reject { |k, _v| k == 1 }
-          )
-        end
+        def lutaml_file(document, reader)
 
-        def process(parent, reader, attrs)
-          uml_document = ::Lutaml::Uml::Parsers::Dsl.parse(lutaml_temp(parent.document, reader))
-          filename = generate_file(parent, reader, uml_document)
-          through_attrs = generate_attrs(attrs)
-          through_attrs["target"] = filename
-          through_attrs["title"] = uml_document.caption
-          create_image_block(parent, through_attrs)
-        rescue StandardError => e
-          abort(parent, reader, attrs, e.message)
+          lutaml_temp(document, reader)
         end
 
         private
@@ -45,42 +26,6 @@ module Metanorma
           temp_file.rewind
           temp_file
         end
-
-        # if no :imagesdir: leave image file in lutaml
-        def generate_file(parent, _reader, uml_document)
-          formatter = ::Lutaml::Uml::Formatter::Graphviz.new
-          formatter.type = :png
-
-          imagesdir = if parent.document.attr("imagesdir")
-                        File.join(parent.document.attr("imagesdir"), "lutaml")
-                      else
-                        "lutaml"
-                      end
-          result_path = Utils.relative_file_path(parent.document, imagesdir)
-          result_pathname = Pathname.new(result_path)
-          result_pathname.mkpath
-          File.writable?(result_pathname) || raise("Destination path #{result_path} not writable for Lutaml!")
-
-          outfile = Tempfile.new(["lutaml", ".png"])
-          outfile.binmode
-          outfile.puts(formatter.format(uml_document))
-
-          # Warning: metanorma/metanorma-standoc#187
-          # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
-          # This is why we need to copy and then unlink.
-          filename = File.basename(outfile.path)
-          FileUtils.cp(outfile, result_pathname) && outfile.unlink
-
-          File.join(result_pathname, filename)
-        end
-
-        def generate_attrs(attrs)
-          %w(id align float title role width height alt)
-            .reduce({}) do |memo, key|
-              memo[key] = attrs[key] if attrs.has_key? key
-              memo
-            end
-        end
       end
     end
   end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "metanorma/plugin/lutaml/lutaml_diagram_base"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlDiagramBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
+        include LutamlDiagramBase
+
+        use_dsl
+        named :lutaml_diagram
+
+        def lutaml_file(document, file_path)
+          File.new(Utils.relative_file_path(document, file_path))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlFigureInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+        include LutamlDiagramBase
+
+        use_dsl
+        named :lutaml_figure
+
+        def process(parent, _target, attrs)
+          diagram_key = [attrs["package"], attrs["name"]].compact.join(":")
+          return if parent.document.attributes['lutaml_figure_id'].nil?
+          xmi_id = parent.document.attributes['lutaml_figure_id'][diagram_key]
+          return unless xmi_id
+
+          %Q(<xref target="figure-#{xmi_id}"></xref>)
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module Metanorma
       #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
       class LutamlUmlAttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
         MARCO_REGEXP =
-          /\[lutaml_uml_attributes_table,([^,]+),?(.+)?,([^,]+),?(.+)?\]/
+          /\[lutaml_uml_attributes_table,([^,]+),?([^,]+),?(.+?)?\]/
         # search document for block `datamodel_attributes_table`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
@@ -36,15 +36,16 @@ module Metanorma
           input_lines.each_with_object([]) do |line, result|
             if match = line.match(MARCO_REGEXP)
               lutaml_path = match[1]
-              entity_name = match[3]
-              result.push(*parse_marco(lutaml_path, entity_name, document))
+              entity_name = match[2]
+              skip_headers = match[3]
+              result.push(*parse_marco(lutaml_path, entity_name, document, skip_headers))
             else
               result.push(line)
             end
           end
         end
 
-        def parse_marco(lutaml_path, entity_name, document)
+        def parse_marco(lutaml_path, entity_name, document, skip_headers)
           lutaml_document = lutaml_document_from_file(document, lutaml_path)
             .serialized_document
           entities = [lutaml_document["classes"], lutaml_document["enums"]]
@@ -53,12 +54,12 @@ module Metanorma
           entity_definition = entities.detect do |klass|
             klass["name"] == entity_name.strip
           end
-          model_representation(entity_definition, document)
+          model_representation(entity_definition, document, skip_headers)
         end
 
-        def model_representation(entity_definition, document)
+        def model_representation(entity_definition, document, skip_headers)
           render_result, errors = Utils.render_liquid_string(
-            template_string: table_template,
+            template_string: table_template(skip_headers),
             context_items: entity_definition,
             context_name: "definition",
             document: document
@@ -68,9 +69,9 @@ module Metanorma
         end
 
         # rubocop:disable Layout/IndentHeredoc
-        def table_template
+        def table_template(skip_headers)
           <<~TEMPLATE
-          === {{ definition.name }}
+          #{"=== {{ definition.name }}" unless skip_headers}
           {{ definition.definition }}
 
           {% if definition.attributes %}
@@ -89,7 +90,7 @@ module Metanorma
           |Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
 
           {% for item in definition.attributes %}
-          |{{ item.name }} |{% if item.definition %}{{ item.definition }}{% else %}TODO: enum {{ key }}'s 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 }}`
+          |{{ 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 }}`
           {% endfor %}
           |===
           {% endif %}