metanorma-plugin-lutaml 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a594ac058de2a8fc661fa9354e32c3e53cbba9ba831eb2241866c3fe50fef39e
-  data.tar.gz: c9ccd2ad0f3d8bcb39da897b733f0c84a8aebf2b434f0c05e4229700e96b1042
+  metadata.gz: 213cd8b2ecaa1b45360480fc2de787f6708b625f5370b7e7617317d77b703ee6
+  data.tar.gz: 396fd04d0ac3f979a6a9ee3b425988fc17af5a267b8e140438a92b73ac41dd5f
 SHA512:
-  metadata.gz: 2761bf514acf0b0861a18c7d9182834868d3061e8720373e2e57bf5f31216e7a5c66e08fee6069f93c59074c352b8f4fb6f416cbd5a1644df0d55dc6db59860e
-  data.tar.gz: 86489b0e1915b61997af3f55388ea4b788fe505188caca2efd40589b67c1ba4e9a0acba591d111c0af7c4943dbad1a3bd69dc0c0dd737663e93b1ada5436d046
+  metadata.gz: 37ad00c2a5bed4ddd9314ad99883545b526ed461e92d99de045072e900592c09798d82dc6119017a5e7656d891c1ea0cc331c844801ec2c0b4d2aae8784775aa
+  data.tar.gz: b8b6cb960be27fc5612c7a987250cd607ea0ae3f07dec61e44334765a64f7d5c22d245a108f2bbfdd4ec6fdc34e3b822b87fb801f70a3406611639d887ea00a9

data/README.adoc

@@ -285,31 +285,45 @@ The `lutaml_uml_datamodel_description` macro can be used:
 -----
 [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
----
+...
 --
 --
 -----
@@ -324,96 +338,104 @@ Where:
 
 * `[.after, package="Another"]` - macro with text to be inserted before(after in case of `.before` name) the package
 
-
-Will produce this output:
-
+* `[.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]
 -----
-= preface
-my text
-
-text before Another package
-
-=== Another
-
-[[rc_another-model_section]]
-==== Another
-
-==== Requirements
-
-==== Class Definitions
+{% 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.
 
-.Classes used in Another
-[cols="2a,6a",options="header"]
-|===
-|Class |Description
+* `[.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`.
 
-|<<AbstractAtomicTimeseries-section,AbstractAtomicTimeseries>>
-«»
-|
+* `[.include_block, package="Another", base_path="spec/fixtures"]` - same as above, but include block will be included only for supplied package name
 
 
-|<<AbstractTimeseries-section,AbstractTimeseries>>
-«»
-|
+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[]
 
-.Data Types used in Another
-[cols="2,6",options="header"]
-|===
-|Name |Description
+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[]
 
-|<<ADEOfAbstractAtomicTimeseries-section,ADEOfAbstractAtomicTimeseries>>
-|
+The CityGML package is organized into
+2 packages with 1 modules:
 
+[arabic]
+. Another package
+. CityTML package
 
-|<<ADEOfAbstractTimeseries-section,ADEOfAbstractTimeseries>>
-|
+my text
 
-....
-|===
+Content for CityGML package
 
+==== Defining tables
 
+[arabic]
+.<<tab-P-another-C-abstractatomictimeseries>> -- Elements of Another::AbstractAtomicTimeseries
 
-.Enumerated Classes used in Another
-[cols="2a,6a",options="header"]
+[[tab-P-another-C-abstractatomictimeseries]]
+.Elements of Another::AbstractAtomicTimeseries
+[width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
-|Name |Description
-
-|<<TimeseriesTypeValue-section,TimeseriesTypeValue>>
+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 Another package
-
-
-=== CityGML
-
-[[rc_citygml-model_section]]
-==== CityGML
-
-==== Requirements
-
-==== Class Definitions
-
-==== Additional Information
+=== Additional Information
 
 text after CityGML package
-
-
-= footer
-footer text
-
 -----
 
 In addition to just supplying XMI file, this macro also supports YAML

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

@@ -1,27 +1,23 @@
 {% 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] }}
+{{ 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 %}
-{% assign package_name = package.name | downcase | replace: ":", "" | replace: " ", "_" %}
 
 {% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
 {{equalsigns}}= {{ package.name }} overview
 
-// TODO: include blocks by base path
-//{% for diagram in package.diagrams %}
-//[[figure-{{ diagram.xmi_id }}]]
-//.{{ diagram.name }}
-//image::../../xmi-19170-only/Images/{{ diagram.xmi_id }}.png[]
-//
-//{% if diagram.definition %}
-//{{ diagram.definition | html2adoc }}
-//{% endif %}
-//{% endfor %}
+{% 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 %}:
@@ -38,7 +34,7 @@
 {% endif %}
 {% endfor %}
 
-{% if package.classes.size > 0 %}
+{% if package.classes.size > 0 or package.enums.size > 0 or package.data_types.size > 0 %}
 
 {{equalsigns}}= Defining tables
 
@@ -83,26 +79,41 @@
 {% include "packages_data_type" %}
 {% endfor %}
 
-// TODO: include blocks by base path
-// {% capture requirement_filename %}requirements/REQ_{{ package_name }}{% endcapture %}
-// {% capture requirement_content %}{% include requirement_filename %}{% endcapture %}
-// {% unless requirement_content contains "Liquid error" %}
-// The following requirements apply:
-// {{ requirement_content }}
-//
-// {% for num in (1..5) %}
-// {% capture nested_requirement_filename %}requirements/REQ_{{ package_name }}_{{num}}{% endcapture %}
-// {% capture nested_requirement_content %}{% include nested_requirement_filename %}{% endcapture %}
-// {% unless nested_requirement_content contains "Liquid error" %}
-// {{ nested_requirement_content }}
-// {% endunless %}
-// {% endfor %}
-// {% endunless %}
+{% 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] }}
+{{ 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/lutaml_diagram_base.rb

@@ -5,6 +5,7 @@ require "asciidoctor"
 require "asciidoctor/reader"
 require "lutaml"
 require "lutaml/uml"
+require "lutaml/formatter"
 require "metanorma/plugin/lutaml/utils"
 
 module Metanorma
@@ -41,7 +42,7 @@ module Metanorma
 
         # if no :imagesdir: leave image file in lutaml
         def generate_file(parent, _reader, uml_document)
-          formatter = ::Lutaml::Uml::Formatter::Graphviz.new
+          formatter = ::Lutaml::Formatter::Graphviz.new
           formatter.type = :png
 
           imagesdir = if parent.document.attr("imagesdir")

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

@@ -16,7 +16,6 @@ module Metanorma
           Asciidoctor::Extensions::Preprocessor
         MARCO_REGEXP =
           /\[lutaml_uml_datamodel_description,([^,]+),?(.+)?\]/
-        SUPPORTED_NESTED_MACROSES = %w[before after].freeze
         LIQUID_INCLUDE_PATH = File.join(
           Gem.loaded_specs["metanorma-plugin-lutaml"].full_gem_path,
           "lib", "metanorma", "plugin", "lutaml", "liquid_templates"
@@ -67,25 +66,30 @@ module Metanorma
 
         def collect_additional_context(input_lines, end_mark)
           additional_context = {}
+          block_lines = []
           while (block_line = input_lines.next) != end_mark
-            nested_match = SUPPORTED_NESTED_MACROSES
-              .map { |macro| [macro, block_line.match(/\[.#{macro}(,\s*package=("|')(?<package>.+?)("|'))?\]/)] }
-              .detect { |n| !n.last.nil? }
-            nested_context_value = []
-            if nested_match
-              macro_keyword = [nested_match.first, nested_match.last['package']].compact.join(";")
-              nested_end_mark = input_lines.next
-              while (block_line = input_lines.next) != nested_end_mark
-                nested_context_value.push(block_line)
-              end
-              additional_context[macro_keyword] = nested_context_value
-                .join("\n")
-            end
+            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']]
           {
@@ -143,7 +147,7 @@ module Metanorma
 
         def table_template
           <<~LIQUID
-            {% include "packages", depth: 2, context: context, additional_context: context.additional_context %}
+            {% include "packages", depth: 2, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
           LIQUID
         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)
 
@@ -25,8 +26,8 @@ module Metanorma
                                  context_name:, document:, include_path: nil)
           liquid_template = ::Liquid::Template.parse(template_string)
           # Allow includes for the template
-          include_path ||= Utils.relative_file_path(document, "")
-          liquid_template.registers[:file_system] = ::Liquid::LocalFileSystem.new(include_path)
+          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.3".freeze
+      VERSION = "0.4.4".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.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-28 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -257,6 +257,8 @@ 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