metanorma-plugin-lutaml 0.4.1 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d99e7b02bf3bfbddcf2d2f81d47e0a83e33abdc0617a9032a106e6930cb05f30
-  data.tar.gz: bfc083ccb6fbd3e7824805e90515340812a1a44ba9522485d5b7a9969c36de2a
+  metadata.gz: 0a510a5a23684dee91557fb6047267ca6ac87be25cbe11e0bcad8e4c0d0812b9
+  data.tar.gz: 5d6e5cfc99c66b42ed50b7f6c6b1346fd2887ee9bba4436cacd5fbc56121dde6
 SHA512:
-  metadata.gz: 4f4f9659c0cc4b62cfdd16e43d771eda047ff29c9731d9b397d186a6f0d214681c9c05f7a09f5ccfc70382fcfafae7df0ff833966d8454be2f947ca3ced9e376
-  data.tar.gz: dc4de40cee4c6ea453936fe4097f732bea18aa5c92ecedbf9789a9719a994edb4afd0088d9b13fffdfc811b960be391c4272282cb39c063685c46e8865fad2b6
+  metadata.gz: ea2e863ee349fb9bc5e60c43802569b0592b3437f2aad58f5bdb5591ecd430388566aff7ad8ff6d6c187e64868df9f1f303917afa94e73396e5c6d6564d0571a
+  data.tar.gz: dc8d9a72fbea070f7aec02fa576c59859ce34abf6375e307ef18685cdbd70130edcc3958839e7b82e9e7155befc8b51657c685d5f42cef96e900de0fd4a50532

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/README.adoc

@@ -64,9 +64,19 @@ Where:
 
 * content within the block is called the "`template`";
 
-* `{example.exp}` is the location of the exp schema file that contains data to be loaded. Location of the file is computed relative to the source directory that `[lutaml]` is used (e.g., if `[lutaml,example.exp,my_context]` is invoked in an `.adoc` file located at `/foo/bar/doc.adoc`, the data file is expected to be found at `/foo/bar/example.exp`);
-
-* `{my_context}` is the name where the EXPRESS Repository read from the .exp file can be accessed with. Context object is a serialized  Expressir::Model::Repository object with all variable names available. See https://github.com/lutaml/expressir[Expressir] docs for reference. `{my_context}` has `schemas` method to access Expressir https://github.com/lutaml/expressir/blob/master/lib/expressir/model/schema.rb[schemas]
+* `{example.exp}` is the location of the EXPRESS schema file (`*.exp`) that
+contains data to be loaded. Location of the file is computed relative to the
+source directory that `[lutaml]` is used (e.g., if
+`[lutaml,example.exp,my_context]` is invoked in an `.adoc` file located at
+`/foo/bar/doc.adoc`, the data file is expected to be found at
+`/foo/bar/example.exp`);
+
+* `{my_context}` is the name where the EXPRESS Repository read from the .exp
+file can be accessed with. Context object is a serialized
+`Expressir::Model::Repository` object with all variable names available. See
+https://github.com/lutaml/expressir[Expressir] docs for reference.
+`{my_context}` has `schemas` method to access Expressir
+https://github.com/lutaml/expressir/blob/master/lib/expressir/model/schema.rb[schemas]
 
 Will produce this output:
 
@@ -83,7 +93,11 @@ Will produce this output:
 
 This macro also supports `.lutaml` files.
 
-Instead of using the direct path to the file one can use `lutaml-express-index` document attribute to supply directory with express files or yaml index file to parse as well as the cache file location. The syntax is as follows:
+Instead of using the direct path to the file one can use `lutaml-express-index`
+document attribute to supply directory with express files or YAML index file to
+parse as well as the cache file location.
+
+The syntax is as follows:
 
 [source,adoc]
 -----
@@ -92,13 +106,15 @@ Instead of using the direct path to the file one can use `lutaml-express-index`
 
 Where:
 
-* `my_custom_name` - is name of the parsed express files context for the later use with lutaml macro
+* `my_custom_name` - is name of the parsed EXPRESS files context for the later
+use with lutaml macro
 
-* `dir_or_index_path` - location of directory with express files or path to yaml index file to parse
+* `dir_or_index_path` - location of directory with EXPRESS files or path to the
+YAML index file to parse
 
-* `cache_path` - optional, location of the expressir cache file to use
+* `cache_path` - optional, location of the Expressir cache file to use
 
-Example of real usage:
+Example of usage:
 
 [source,adoc]
 -----
@@ -113,9 +129,75 @@ Author
 ----
 -----
 
+=== Usage, `lutaml_diagram` macro
+
+This macro allows to quickly render lutaml file as diagram image.
+Given `example.lutaml` file with the content:
+
+[source,java]
+----
+diagram MyView {
+  title "my diagram"
+
+  enum AddressClassProfile {
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition
+        this is multiline with `ascidoc`
+      end definition
+    }
+  }
+
+  class AttributeProfile {
+    +addressClassProfile: CharacterString [0..1]
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition this is attribute definition
+    }
+  }
+}
+----
+
+And the `lutaml_diagram` macro:
+
+[source,adoc]
+-----
+lutaml_diagram::example.lutaml[]
+-----
+
+Will add diagram image to the document
+
+Also one can use `lutaml_diagram` block with embed lutaml code instead of block macro. Example:
+
+[source,java]
+----
+[lutaml_diagram]
+....
+diagram MyView {
+  title "my diagram"
+
+  enum AddressClassProfile {
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition
+        this is multiline with `ascidoc`
+      end definition
+    }
+  }
+
+  class AttributeProfile {
+    +addressClassProfile: CharacterString [0..1]
+    imlicistAttributeProfile: CharacterString [0..1] {
+      definition this is attribute definition
+    }
+  }
+}
+....
+----
+
+
 === Usage, `lutaml_uml_attributes_table` macro
 
-This macro allows to quickly render datamodel attributes/values tables. Given `example.lutaml` file with the content:
+This macro allows to quickly render data model attributes/values tables.
+
+Given `example.lutaml` file with the content:
 
 [source,java]
 ----
@@ -187,6 +269,215 @@ Will produce this output:
 |===
 -----
 
+=== Usage, `lutaml_uml_datamodel_description` macro
+
+This macro allows to quickly render data model packages and its dependent
+objects for supplied XMI file.
+
+Given an Enterprise Architect `example.xmi` file with 2 packages:
+
+* 'Another'
+* 'CityGML'
+
+The `lutaml_uml_datamodel_description` macro can be used:
+
+[source,adoc]
+-----
+[lutaml_uml_datamodel_description, path/to/example.xmi]
+--
+[.before]
+...
+my text
+...
+
+[.diagram_include_block, base_path="requirements/"]
+...
+Diagram text
+...
+
+[.include_block, package="Another", base_path="spec/fixtures"]
+...
+my text
+...
+
+[.include_block, base_path="spec/fixtures"]
+...
+my text
+...
+
+[.before, package="Another"]
+...
+text before Another package
+...
+
+[.after, package="Another"]
+...
+text after Another package
+...
+
+[.after, package="CityGML"]
+...
+text after CityGML package
+...
+
+[.after]
+...
+footer text
+...
+--
+--
+-----
+
+Where:
+
+* `path/to/example.xmi` - required, path to the XMI file to render
+
+* `[.before]` - macro to add additional text before the rendered output, can be used only once, additional occurrences of macro will overwrite text
+
+* `[.after]` - macro to add additional text after the rendered output, can be used only once, additional occurrences of macro will overwrite text
+
+* `[.after, package="Another"]` - macro with text to be inserted before(after in case of `.before` name) the package
+
+* `[.diagram_include_block]` - macro to automatically include diagram images. Attribute `base_path` is a required attribute to supply path prefix where to look for a digram image. The logic is as follows:
+[source,adoc]
+-----
+{% for diagram in package.diagrams %}
+[[figure-{{ diagram.xmi_id }}]]
+.{{ diagram.name }}
+image::{{ image_base_path }}/{{ diagram.xmi_id }}.png[]
+
+{% if diagram.definition %}
+{{ diagram.definition | html2adoc }}
+{% endif %}
+{% endfor %}
+-----
+Eg: script will take package diagrams supplied in xmi file and will try to include `image` with the name equal to diagram' xmi_id attribute plus `.png`. Also one can add any text to the macro text, it will be added as paragraph before each image include.
+
+* `[.diagram_include_block, package="Another"]` - same as above, but diagram will be included only for supplied package name
+
+* `[.include_block, base_path="spec/fixtures"]` - macro to inlude files(adoc/liquid) for each package name. Attribute `base_path` is a required attribute to supply path prefix where to look for file to include. Macro will look for a file called `base_path` + `/` `_package_name`(downcase, replace : -> '', ' ' -> '_') + `.adoc`[`.liquid`], eg for package 'My Package name' and `base_path` eq to `my/path`, macro will look for the following file path: `my/path/_my_package_name.adoc`.
+
+* `[.include_block, package="Another", base_path="spec/fixtures"]` - same as above, but include block will be included only for supplied package name
+
+
+Will produce this output:
+
+[source,adoc]
+-----
+my text
+== CityGML package
+=== CityGML overview
+
+Diagram text
+
+[[figure-EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29]]
+.CityGML Package Diagram
+image::requirements//EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29.png[]
+
+BuildingFurnitureFunctionValue is a code list that enumerates the different purposes of a BuildingFurniture.
+
+[[figure-EAID_938AE961_1C57_4052_B964_997D1894A58D]]
+.Use of ISO and OASIS standards in CityGML
+image::requirements//EAID_938AE961_1C57_4052_B964_997D1894A58D.png[]
+
+The CityGML package is organized into
+2 packages with 1 modules:
+
+[arabic]
+. Another package
+. CityTML package
+
+my text
+
+Content for CityGML package
+
+==== Defining tables
+
+[arabic]
+.<<tab-P-another-C-abstractatomictimeseries>> -- Elements of Another::AbstractAtomicTimeseries
+
+[[tab-P-another-C-abstractatomictimeseries]]
+.Elements of Another::AbstractAtomicTimeseries
+[width="100%",cols="a,a,a,a,a,a,a,a"]
+|===
+h|Name: 7+| AbstractAtomicTimeseries
+h|Definition: 7+|
+h|Stereotype: 7+| interface
+h|Abstract: 7+|
+.1+h|Associations: 7+| (none)
+.4+h|Public attributes:
+| _Name_
+2+| _Definition_
+| _Derived_
+| _Obligation_
+| _Maximum occurrence_
+| _Data type_
+| adeOfAbstractAtomicTimeseries
+2+|
+|
+| C
+| *
+| ADEOfAbstractAtomicTimeseries
+| observationProperty
+2+|
+|
+| M
+| 1
+| CharacterString
+| uom
+2+|
+|
+| C
+| 1
+| CharacterString
+h|Constraints: 7+| (none)
+|===
+
+=== Additional Information
+
+text after CityGML package
+-----
+
+In addition to just supplying XMI file, this macro also supports YAML
+configuration file.
+
+The format for using YAML is this:
+
+[source,yaml]
+-----
+---
+packages:
+  # includes these packages
+  - "Package *"
+  - two*
+  - three
+  # skips these packages
+  - skip: four
+-----
+
+Where:
+
+* `packages` - required, root element with the list of strings or objects
+
+* `Package *` - pattern matching, specifies lookup condition for packages to
+render.
++
+NOTE: In this example, it is equal to the following regular expression: `/^Package.*$/`
+
+* `skip: four` - object with package name to skip
+
+Usage with macro:
+
+[source,adoc]
+-----
+[lutaml_uml_datamodel_description, path/to/example.xmi, path/to/config.yml]
+....
+-----
+
+The macro processor will read supplied YAML file and arrange packages according
+to the order supplied in the config file, also all packages supplied as `skip`
+will be skipped during render
+
 == Documentation
 
-See https://www.metanorma.com.
+Please refer to https://www.metanorma.com.

data/lib/metanorma-plugin-lutaml.rb

@@ -1,7 +1,9 @@
 require "metanorma/plugin/lutaml/version"
 require "metanorma/plugin/lutaml/lutaml_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor"
+require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_diagram_block"
+require "metanorma/plugin/lutaml/lutaml_diagram_block_macro"
 
 module Metanorma
   module Plugin

data/lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb

@@ -0,0 +1,53 @@
+module Metanorma
+  module Plugin
+    module Lutaml
+      module Liquid
+        class LocalFileSystem
+          attr_accessor :roots, :patterns
+
+          def initialize(roots, patterns = ["_%s.liquid"])
+            @roots    = roots
+            @patterns = patterns
+          end
+
+          def read_template_file(template_path)
+            full_path = full_path(template_path)
+            raise FileSystemError, "No such template '#{template_path}'" unless File.exist?(full_path)
+
+            File.read(full_path)
+          end
+
+          def full_path(template_path)
+            raise ::Liquid::FileSystemError, "Illegal template name '#{template_path}'" unless %r{\A[^./][a-zA-Z0-9_/]+\z}.match?(template_path)
+
+            result_path = if template_path.include?('/')
+              roots
+                .map do |root|
+                  patterns.map do |pattern|
+                    File.join(root, File.dirname(template_path), pattern % File.basename(template_path))
+                  end
+                end
+                .flatten
+                .find { |path| File.file?(path) }
+            else
+              roots
+                .map do |root|
+                  patterns.map do |pattern|
+                    File.join(root, pattern % template_path)
+                  end
+                end
+                .flatten
+                .find { |path| File.file?(path) }
+            end
+
+            unless roots.any? { |root| File.expand_path(result_path).start_with?(File.expand_path(root)) }
+              raise ::Liquid::FileSystemError, "Illegal template path '#{File.expand_path(result_path)}'"
+            end
+
+            result_path
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+{{ text }}
+
+{% for diagram in package.diagrams %}
+[[figure-{{ diagram.xmi_id }}]]
+.{{ diagram.name }}
+image::{{ image_base_path }}/{{ diagram.xmi_id }}.png[]
+
+{% if diagram.definition %}
+{{ diagram.definition | html2adoc }}
+{% endif %}
+{% endfor %}

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

@@ -0,0 +1,119 @@
+{% for package in context.packages %}
+{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
+{% if additional_context.before %}
+{{ additional_context.before.text }}
+{% endif %}
+{% assign before_package_key = 'before;' | append: package.name %}
+{% if additional_context[before_package_key] %}
+{{ additional_context[before_package_key].text }}
+{% endif %}
+{% assign is_package_spare = package.name | slice: 0,5 %}
+{% if is_package_spare == 'old: ' %}{% continue %}
+{% elsif is_package_spare == 'Spare' %}{% continue %}
+{% endif %}
+
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
+{{equalsigns}}= {{ package.name }} overview
+
+{% if additional_context.diagram_include_block %}
+{% include "diagrams_block", package_name: package_name, image_base_path: additional_context.diagram_include_block.base_path, text: additional_context.diagram_include_block.text %}
+{% endif %}
+
+{% if package.packages.size > 0 %}The {{ package.name }} package is organized into
+{{ package.packages.size }} packages{% assign modules_nested_size = 0 %}{% for module in package.packages %}{% assign modules_nested_size = modules_nested_size | plus: module.packages.size %}{% endfor %}{% if modules_nested_size > 0 %} with {{modules_nested_size}} modules{% endif %}:
+{% endif %}
+[arabic]
+{% for module in package.packages %}
+{% if module.packages.length > 0 %}
+. {{ module.name }} package comprises:
+{% for nested_module in module.packages %}
+.. {{nested_module.name}} module
+{% endfor %}
+{% else %}
+. {{ module.name }} package
+{% endif %}
+{% endfor %}
+
+{% if package.classes.size > 0 or package.enums.size > 0 or package.data_types.size > 0 %}
+
+{{equalsigns}}= Defining tables
+
+[arabic]
+{% for klass in package.classes %}
+{% 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 }}-C-{{ klass_name }}>> -- Elements of {{ package.name }}::{{ klass.name }}
+
+{% endfor %}
+{% for enum in package.enums %}
+{% assign is_enum_spare = enum.name | slice: 0,5 %}
+{% if is_enum_spare == 'old: ' %}{% continue %}
+{% elsif is_enum_spare == 'Spare' %}{% continue %}
+{% endif %}
+{% assign enum_name = enum.name | downcase | replace: ':', '' | replace: ' ', '_' %}
+.<<tab-P-{{ package_name }}-E-{{ enum_name }}>> -- Elements of {{ package.name }}::{{ enum.name }}
+
+{% endfor %}
+{% for data_type in package.data_types %}
+{% assign is_data_type_spare = data_type.name | slice: 0,5 %}
+{% if is_data_type_spare == 'old: ' %}{% continue %}
+{% elsif is_data_type_spare == 'Spare' %}{% continue %}
+{% endif %}
+{% assign data_type_name = data_type.name | downcase | replace: ':', '' | replace: ' ', '_' %}
+.<<tab-P-{{ package_name }}-DT-{{ data_type_name }}>> -- Elements of {{ package.name }}::{{ data_type.name }}
+
+{% endfor %}
+
+{% for klass in package.classes %}
+{% include "packages_class" %}
+{% endfor %}
+
+{% for klass in package.enums %}
+{% include "packages_enum" %}
+{% endfor %}
+
+{% for klass in package.data_types %}
+{% include "packages_data_type" %}
+{% endfor %}
+
+{% endif %}
+
+{% if additional_context.include_block %}
+{% assign block = 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 %}
+{% endif %}
+
+{% assign include_block_package_key = 'include_block;' | append: package.name %}
+{% assign block = additional_context[include_block_package_key] %}
+{% if 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 %}
+{% endif %}
+
+{% assign after_package_key = 'after;' | append: package.name %}
+{{equalsigns}}= Additional Information
+{% if additional_context[after_package_key] %}
+{{ additional_context[after_package_key].text }}
+{% endif %}
+{% if package.packages.size > 0 and render_nested_packages %}{% assign nested_depth = depth | plus: 1 %}{% include "packages", depth: nested_depth, context: package %}{% endif %}
+{% endfor %}
+
+{% if additional_context.after %}
+{{ additional_context.after.text }}
+{% endif %}

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

@@ -0,0 +1,81 @@
+{% 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 }}-C-{{ 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.attributes.size > 0 %}
+.{{klass.attributes.size | plus: 1}}+h|Public attributes:
+| _Name_
+2+| _Definition_
+| _Derived_
+| _Obligation_
+| _Maximum occurrence_
+| _Data type_
+
+{% for attr in klass.attributes %}
+| {{attr.name}}
+2+| {{ attr.definition | html2adoc }}
+| {{ attr.is_derived }}
+| {{attr.cardinality.min}}
+| {{attr.cardinality.max}}
+| {{attr.type}}
+
+{% endfor %}
+{% else %}
+.1+h|Public attributes:
+7+| (none)
+{% endif %}
+
+{% if klass.constraints.size > 0 %}
+.{{ klass.constraints.size }}+|*Constraints:*
+{% for constr in klass.constraints %}
+7+| `{{ constr.body }}`
+
+{% endfor %}
+{% else %}
+
+h|Constraints: 7+| (none)
+{% endif %}
+
+|===

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_type.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 }}-DT-{{ 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.attributes.size > 0 %}
+.{{klass.attributes.size | plus: 1}}+h|Values:
+| _Name_
+6+| _Definition_
+
+{% for value in klass.attributes %}
+| {{value.name}}
+6+| {{ value.definition | html2adoc }}
+
+{% endfor %}
+{% else %}
+.1+h|Values:
+7+| (none)
+{% 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,86 +1,31 @@
 # 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(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
 
-        def lutaml_temp(reader)
-          temp_file = Tempfile.new(["lutaml", ".lutaml"])
+        def lutaml_temp(document, reader)
+          temp_file = Tempfile.new(["lutaml", ".lutaml"], Utils.relative_file_path(document, ''))
           temp_file.puts(reader.read)
           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_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 %}

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

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "asciidoctor"
+require "asciidoctor/reader"
+require "lutaml"
+require "lutaml/uml"
+require "metanorma/plugin/lutaml/utils"
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      #  Macro for quick rendering of datamodel attributes/values table
+      #  @example [lutaml_uml_attributes_table,path/to/lutaml,EntityName]
+      class LutamlUmlDatamodelDescriptionPreprocessor <
+          Asciidoctor::Extensions::Preprocessor
+        MARCO_REGEXP =
+          /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/
+        LIQUID_INCLUDE_PATH = File.join(
+          Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
+          "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
+        )
+        # search document for block `lutaml_uml_datamodel_description`
+        #  read include derectives that goes after that in block and transform
+        #  into yaml2text blocks
+        def process(document, reader)
+          input_lines = reader.readlines.to_enum
+          Asciidoctor::Reader.new(processed_lines(document, input_lines))
+        end
+
+        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
+        end
+
+        def parse_yaml_config_file(document, file_path)
+          return {} if file_path.nil?
+
+          relative_file_path = Utils.relative_file_path(document, file_path)
+          YAML.load(File.read(relative_file_path, encoding: "UTF-8"))
+        end
+
+        def processed_lines(document, input_lines)
+          result = []
+          loop do
+            result.push(*process_text_blocks(document, input_lines))
+          end
+          result
+        end
+
+        def process_text_blocks(document, input_lines)
+          line = input_lines.next
+          block_match = line.match(MARCO_REGEXP)
+          return [line] if block_match.nil?
+
+          model_representation(
+            lutaml_document_from_file(document, block_match[1]),
+            document,
+            collect_additional_context(input_lines, input_lines.next),
+            parse_yaml_config_file(document, block_match[2]))
+        end
+
+        def collect_additional_context(input_lines, end_mark)
+          additional_context = {}
+          block_lines = []
+          while (block_line = input_lines.next) != end_mark
+            block_lines.push(block_line)
+          end
+          block_document = (Asciidoctor::Document.new(block_lines, {})).parse
+          block_document.blocks.each do |block|
+            attrs = block.attributes
+            name = attrs.delete('role')
+            package = attrs.delete('package')
+            macro_keyword = [name, package].compact.join(";")
+            additional_context[macro_keyword] = { 'text' => block.lines[1..-2].join("\n") }.merge(attrs)
+          end
+          additional_context
+        end
+
+        def create_context_object(lutaml_document, additional_context, options)
+          if options.length.zero?
+            return {
+              'render_nested_packages' => true,
+              "packages" => lutaml_document.to_liquid['packages'].first['packages'].first['packages'],
+              "additional_context" => additional_context
+            }
+          end
+
+          root_package = lutaml_document.to_liquid['packages'].first
+          all_packages = [root_package, *root_package['children_packages']]
+          {
+            "packages" => sort_and_filter_out_packages(all_packages, options),
+            "additional_context" => additional_context
+          }
+        end
+
+        def sort_and_filter_out_packages(all_packages, options)
+          return all_packages if options['packages'].nil?
+
+          result = []
+          # Step one - filter out all skipped packages
+          options['packages']
+            .find_all { |entity| entity.is_a?(Hash) && entity['skip'] }
+            .each do |entity|
+              entity_regexp = config_entity_regexp(entity['skip'])
+              all_packages
+                .delete_if {|package| package['name'] =~ entity_regexp }
+            end
+          # Step two - select supplied packages by pattern
+          options['packages']
+            .find_all { |entity| entity.is_a?(String) }
+            .each do |entity|
+              entity_regexp = config_entity_regexp(entity)
+              all_packages.each.with_index do |package|
+                if package['name'] =~ entity_regexp
+                  result.push(package)
+                  all_packages
+                    .delete_if {|nest_package| nest_package['name'] == package['name'] }
+                end
+              end
+            end
+          result
+        end
+
+        def config_entity_regexp(entity)
+          additional_sym = '.*' if entity =~ /\*$/
+          %r{^#{Regexp.escape(entity.gsub('*', ''))}#{additional_sym}$}
+        end
+
+        def model_representation(lutaml_document, document, additional_context, options)
+          render_result, errors = Utils.render_liquid_string(
+            template_string: table_template,
+            context_items: create_context_object(lutaml_document,
+                              additional_context,
+                              options),
+            context_name: "context",
+            document: document,
+            include_path: LIQUID_INCLUDE_PATH
+          )
+          Utils.notify_render_errors(document, errors)
+          render_result.split("\n")
+        end
+
+        def table_template
+          <<~LIQUID
+            {% include "packages", depth: 2, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
+          LIQUID
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 require "expressir/express/cache"
 require "metanorma/plugin/lutaml/liquid/custom_filters"
+require "metanorma/plugin/lutaml/liquid/multiply_local_file_system"
 
 ::Liquid::Template.register_filter(Metanorma::Plugin::Lutaml::Liquid::CustomFilters)
 
@@ -22,10 +23,11 @@ module Metanorma
         end
 
         def render_liquid_string(template_string:, context_items:,
-                                 context_name:, document:)
+                                 context_name:, document:, include_path: nil)
           liquid_template = ::Liquid::Template.parse(template_string)
           # Allow includes for the template
-          liquid_template.registers[:file_system] = ::Liquid::LocalFileSystem.new(Utils.relative_file_path(document, ""))
+          include_paths = [Utils.relative_file_path(document, ""), include_path].compact
+          liquid_template.registers[:file_system] = ::Metanorma::Plugin::Lutaml::Liquid::LocalFileSystem.new(include_paths, ["_%s.liquid", "_%s.adoc"])
           rendered_string = liquid_template
             .render(context_name => context_items,
                     strict_variables: true,

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -243,6 +243,8 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -255,9 +257,18 @@ files:
 - lib/metanorma-plugin-lutaml.rb
 - lib/metanorma/plugin/lutaml/express_remarks_decorator.rb
 - lib/metanorma/plugin/lutaml/liquid/custom_filters.rb
+- lib/metanorma/plugin/lutaml/liquid/multiply_local_file_system.rb
+- lib/metanorma/plugin/lutaml/liquid_templates/_diagrams_block.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_type.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_packages_enum.liquid
+- lib/metanorma/plugin/lutaml/lutaml_diagram_base.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
+- lib/metanorma/plugin/lutaml/lutaml_diagram_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb
+- lib/metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor.rb
 - lib/metanorma/plugin/lutaml/utils.rb
 - lib/metanorma/plugin/lutaml/version.rb
 - metanorma-plugin-lutaml.gemspec